From 474235718469c6ad1851b643b72714a45d6b704b Mon Sep 17 00:00:00 2001 From: =?utf8?q?David=20=E2=80=98Bombe=E2=80=99=20Roden?= Date: Tue, 3 Sep 2024 11:12:05 +0200 Subject: [PATCH] =?utf8?q?=F0=9F=93=9D=20Add=20some=20@param=20tags=20to?= =?utf8?q?=20appease=20javadoc?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit --- src/main/java/net/pterodactylus/fcp/AddPeer.java | 15 +++++++++------ src/main/java/net/pterodactylus/fcp/FCPPluginMessage.java | 3 +++ src/main/java/net/pterodactylus/fcp/FcpListener.java | 5 ++--- 3 files changed, 14 insertions(+), 9 deletions(-) diff --git a/src/main/java/net/pterodactylus/fcp/AddPeer.java b/src/main/java/net/pterodactylus/fcp/AddPeer.java index c2a0555..ad71ce4 100644 --- a/src/main/java/net/pterodactylus/fcp/AddPeer.java +++ b/src/main/java/net/pterodactylus/fcp/AddPeer.java @@ -49,8 +49,9 @@ public class AddPeer extends FcpMessage { * Creates a new “AddPeer” request that reads the noderef of the peer from * the given file. * - * @param file - * The file to read the noderef from + * @param trust The trust values for the new peer + * @param visibility The visibility of the new peer + * @param file The file to read the noderef from */ public AddPeer(Trust trust, Visibility visibility, String file) { this(trust, visibility); @@ -66,8 +67,9 @@ public class AddPeer extends FcpMessage { * Creates a new “AddPeer” request that reads the noderef of the peer from * the given URL. * - * @param url - * The URL to read the noderef from + * @param trust The trust values for the new peer + * @param visibility The visibility of the new peer + * @param url The URL to read the noderef from */ public AddPeer(Trust trust, Visibility visibility, URL url) { this(trust, visibility); @@ -82,8 +84,9 @@ public class AddPeer extends FcpMessage { /** * Creates a new “AddPeer” request that adds the peer given by the noderef. * - * @param nodeRef - * The noderef of the peer + * @param trust The trust values for the new peer + * @param visibility The visibility of the new peer + * @param nodeRef The noderef of the peer */ public AddPeer(Trust trust, Visibility visibility, NodeRef nodeRef) { this(trust, visibility); diff --git a/src/main/java/net/pterodactylus/fcp/FCPPluginMessage.java b/src/main/java/net/pterodactylus/fcp/FCPPluginMessage.java index 19a2d6b..901f0be 100644 --- a/src/main/java/net/pterodactylus/fcp/FCPPluginMessage.java +++ b/src/main/java/net/pterodactylus/fcp/FCPPluginMessage.java @@ -29,6 +29,7 @@ public class FCPPluginMessage extends FcpMessage { /** * @deprecated Use {@link #FCPPluginMessage(String, String)} instead + * @param pluginClass The name of the plugin’s main class */ @Deprecated public FCPPluginMessage(String pluginClass) { @@ -43,6 +44,7 @@ public class FCPPluginMessage extends FcpMessage { /** * @deprecated Use {@link #FCPPluginMessage(String, String)} instead + * @param identifier The identifier of the message */ @Deprecated public void setIdentifier(String identifier) { @@ -63,6 +65,7 @@ public class FCPPluginMessage extends FcpMessage { /** * @deprecated Use {@link #setData(InputStream, long)} instead + * @param dataLength The length of the additional data in this message */ @Deprecated public void setDataLength(long dataLength) { diff --git a/src/main/java/net/pterodactylus/fcp/FcpListener.java b/src/main/java/net/pterodactylus/fcp/FcpListener.java index 7ff3f96..68688dc 100644 --- a/src/main/java/net/pterodactylus/fcp/FcpListener.java +++ b/src/main/java/net/pterodactylus/fcp/FcpListener.java @@ -405,9 +405,8 @@ public interface FcpListener extends EventListener { /** * Notifies a listener that a message has been received. This method is - * only called if {@link FcpConnection#handleMessage(FcpMessage)} does not - * recognize the message. Should that ever happen, please file a bug - * report! + * only called if an unrecognized message is received. Should that ever + * happen, please file a bug report! * * @param fcpConnection * The connection that received the message -- 2.7.4