MiniDay/Velocity
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

Fix a few javadoc-related problems

Browse Source
This commit is contained in:
Riley Park
2020-10-15 08:24:41 -07:00
parent 6e00dbe2b7
commit a76c01df4b
4 changed files with 16 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
api/src/main/java/com/velocitypowered/api/command/CommandSource.java
View File

@@ -3,6 +3,7 @@ package com.velocitypowered.api.command;
import com.velocitypowered.api.permission.PermissionSubject;
import net.kyori.adventure.audience.Audience;
import net.kyori.adventure.audience.MessageType;
import net.kyori.adventure.identity.Identified;
import net.kyori.adventure.identity.Identity;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.serializer.legacytext3.LegacyText3ComponentSerializer;
@@ -17,7 +18,8 @@ public interface CommandSource extends Audience, PermissionSubject {
* Sends the specified {@code component} to the invoker.
*
* @param component the text component to send
* @deprecated Use {@link #sendMessage(Component)} instead
* @deprecated Use {@link #sendMessage(Identified, Component)}
* or {@link #sendMessage(Identity, Component)} instead
*/
@Deprecated
void sendMessage(net.kyori.text.Component component);

9
api/src/main/java/com/velocitypowered/api/proxy/Player.java
View File

@@ -15,6 +15,7 @@ import java.util.List;
import java.util.Optional;
import java.util.UUID;
import net.kyori.adventure.identity.Identified;
import net.kyori.adventure.identity.Identity;
import net.kyori.adventure.text.Component;
/**
@@ -77,7 +78,8 @@ public interface Player extends CommandSource, Identified, InboundConnection,
* Sends a chat message to the player's client.
*
* @param component the chat message to send
* @deprecated Use {@link #sendMessage(net.kyori.adventure.text.Component)}
* @deprecated Use {@link #sendMessage(Identified, Component)}
* or {@link #sendMessage(Identity, Component)} instead
*/
@Deprecated
@Override
@@ -90,8 +92,9 @@ public interface Player extends CommandSource, Identified, InboundConnection,
*
* @param component the chat message to send
* @param position the position for the message
* @deprecated Use @deprecated Use {@link #sendMessage(net.kyori.adventure.text.Component)} or
* {@link #sendActionBar(net.kyori.adventure.text.Component)}
* @deprecated Use @deprecated Use {@link #sendMessage(Identified, Component)} or
* {@link #sendMessage(Identity, Component)} for chat messages, or
* {@link #sendActionBar(net.kyori.adventure.text.Component)} for action bar messages
*/
@Deprecated
void sendMessage(net.kyori.text.Component component, MessagePosition position);

8
api/src/main/java/com/velocitypowered/api/proxy/ProxyServer.java
View File

@@ -18,6 +18,9 @@ import java.util.Collection;
import java.util.Optional;
import java.util.UUID;
import net.kyori.adventure.audience.Audience;
import net.kyori.adventure.identity.Identified;
import net.kyori.adventure.identity.Identity;
import net.kyori.adventure.text.Component;
import org.checkerframework.checker.nullness.qual.NonNull;
/**
@@ -26,7 +29,7 @@ import org.checkerframework.checker.nullness.qual.NonNull;
public interface ProxyServer extends Audience {
/**
* Shuts down the proxy, kicking players with the specified {@param reason}.
* Shuts down the proxy, kicking players with the specified {@code reason}.
*
* @param reason message to kick online players with
*/
@@ -58,7 +61,8 @@ public interface ProxyServer extends Audience {
* Broadcasts a message to all players currently online.
*
* @param component the message to send
* @deprecated Use {@link #sendMessage(net.kyori.adventure.text.Component)} instead
* @deprecated Use {@link #sendMessage(Identified, Component)}
* or {@link #sendMessage(Identity, Component)} instead
*/
@Deprecated
void broadcast(net.kyori.text.Component component);

2
api/src/main/java/com/velocitypowered/api/util/title/package-info.java
View File

@@ -1,6 +1,6 @@
/**
* Provides data structures for creating and manipulating titles.
*
* @deprecated Replaced with {@link net.kyori.adventure.title}
* @deprecated Replaced with {@link net.kyori.adventure.title.Title}
*/
package com.velocitypowered.api.util.title;