From: David ‘Bombe’ Roden <bombe@pterodactylus.net>
Date: Sat, 12 Apr 2008 22:10:23 +0000 (+0000)
Subject: enhance javadoc
X-Git-Url: https://git.pterodactylus.net/?a=commitdiff_plain;h=387854181348e264090a17a18e7ef23c207d3559;p=jSite2.git

enhance javadoc

git-svn-id: http://trooper/svn/projects/jSite/trunk@749 c3eda9e8-030b-0410-8277-bc7414b0a119
---

diff --git a/src/net/pterodactylus/util/fcp/FcpConnection.java b/src/net/pterodactylus/util/fcp/FcpConnection.java
index bb0ac40..748bb8f 100644
--- a/src/net/pterodactylus/util/fcp/FcpConnection.java
+++ b/src/net/pterodactylus/util/fcp/FcpConnection.java
@@ -305,6 +305,7 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that a “PersistentGet” message was received.
 	 * 
+	 * @see FcpListener#receivedPersistentGet(FcpConnection, PersistentGet)
 	 * @param persistentGet
 	 *            The “PersistentGet” message
 	 */
@@ -331,6 +332,8 @@ public class FcpConnection {
 	 * Notifies all listeners that a “EndListPersistentRequests” message was
 	 * received.
 	 * 
+	 * @see FcpListener#receivedEndListPersistentRequests(FcpConnection,
+	 *      EndListPersistentRequests)
 	 * @param endListPersistentRequests
 	 *            The “EndListPersistentRequests” message
 	 */
@@ -343,6 +346,7 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that a “URIGenerated” message was received.
 	 * 
+	 * @see FcpListener#receivedURIGenerated(FcpConnection, URIGenerated)
 	 * @param uriGenerated
 	 *            The “URIGenerated” message
 	 */
@@ -355,6 +359,7 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that a “DataFound” message was received.
 	 * 
+	 * @see FcpListener#receivedDataFound(FcpConnection, DataFound)
 	 * @param dataFound
 	 *            The “DataFound” message
 	 */
@@ -367,6 +372,7 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that an “AllData” message was received.
 	 * 
+	 * @see FcpListener#receivedAllData(FcpConnection, AllData)
 	 * @param allData
 	 *            The “AllData” message
 	 */
@@ -379,6 +385,7 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that a “SimpleProgress” message was received.
 	 * 
+	 * @see FcpListener#receivedSimpleProgress(FcpConnection, SimpleProgress)
 	 * @param simpleProgress
 	 *            The “SimpleProgress” message
 	 */
@@ -391,6 +398,8 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that a “StartedCompression” message was received.
 	 * 
+	 * @see FcpListener#receivedStartedCompression(FcpConnection,
+	 *      StartedCompression)
 	 * @param startedCompression
 	 *            The “StartedCompression” message
 	 */
@@ -403,6 +412,8 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that a “FinishedCompression” message was received.
 	 * 
+	 * @see FcpListener#receviedFinishedCompression(FcpConnection,
+	 *      FinishedCompression)
 	 * @param finishedCompression
 	 *            The “FinishedCompression” message
 	 */
@@ -416,6 +427,8 @@ public class FcpConnection {
 	 * Notifies all listeners that an “UnknownPeerNoteType” message was
 	 * received.
 	 * 
+	 * @see FcpListener#receivedUnknownPeerNoteType(FcpConnection,
+	 *      UnknownPeerNoteType)
 	 * @param unknownPeerNoteType
 	 *            The “UnknownPeerNoteType” message
 	 */
@@ -429,6 +442,8 @@ public class FcpConnection {
 	 * Notifies all listeners that an “UnknownNodeIdentifier” message was
 	 * received.
 	 * 
+	 * @see FcpListener#receivedUnknownNodeIdentifier(FcpConnection,
+	 *      UnknownNodeIdentifier)
 	 * @param unknownNodeIdentifier
 	 *            The “UnknownNodeIdentifier” message
 	 */
@@ -441,6 +456,7 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that a “ConfigData” message was received.
 	 * 
+	 * @see FcpListener#receivedConfigData(FcpConnection, ConfigData)
 	 * @param configData
 	 *            The “ConfigData” message
 	 */
@@ -453,6 +469,7 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that a “GetFailed” message was received.
 	 * 
+	 * @see FcpListener#receivedGetFailed(FcpConnection, GetFailed)
 	 * @param getFailed
 	 *            The “GetFailed” message
 	 */
@@ -465,6 +482,7 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that a “PutFailed” message was received.
 	 * 
+	 * @see FcpListener#receivedPutFailed(FcpConnection, PutFailed)
 	 * @param putFailed
 	 *            The “PutFailed” message
 	 */
@@ -478,6 +496,8 @@ public class FcpConnection {
 	 * Notifies all listeners that an “IdentifierCollision” message was
 	 * received.
 	 * 
+	 * @see FcpListener#receivedIdentifierCollision(FcpConnection,
+	 *      IdentifierCollision)
 	 * @param identifierCollision
 	 *            The “IdentifierCollision” message
 	 */
@@ -490,6 +510,8 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that an “PersistentPutDir” message was received.
 	 * 
+	 * @see FcpListener#receivedPersistentPutDir(FcpConnection,
+	 *      PersistentPutDir)
 	 * @param persistentPutDir
 	 *            The “PersistentPutDir” message
 	 */
@@ -503,6 +525,8 @@ public class FcpConnection {
 	 * Notifies all listeners that a “PersistentRequestRemoved” message was
 	 * received.
 	 * 
+	 * @see FcpListener#receivedPersistentRequestRemoved(FcpConnection,
+	 *      PersistentRequestRemoved)
 	 * @param persistentRequestRemoved
 	 *            The “PersistentRequestRemoved” message
 	 */
@@ -515,6 +539,8 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that a “SubscribedUSKUpdate” message was received.
 	 * 
+	 * @see FcpListener#receivedSubscribedUSKUpdate(FcpConnection,
+	 *      SubscribedUSKUpdate)
 	 * @param subscribedUSKUpdate
 	 *            The “SubscribedUSKUpdate” message
 	 */
@@ -527,6 +553,7 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that a “PluginInfo” message was received.
 	 * 
+	 * @see FcpListener#receivedPluginInfo(FcpConnection, PluginInfo)
 	 * @param pluginInfo
 	 *            The “PluginInfo” message
 	 */
@@ -539,6 +566,7 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that an “FCPPluginReply” message was received.
 	 * 
+	 * @see FcpListener#receivedFCPPluginReply(FcpConnection, FCPPluginReply)
 	 * @param fcpPluginReply
 	 *            The “FCPPluginReply” message
 	 */
@@ -552,6 +580,8 @@ public class FcpConnection {
 	 * Notifies all listeners that a “PersistentRequestModified” message was
 	 * received.
 	 * 
+	 * @see FcpListener#receivedPersistentRequestModified(FcpConnection,
+	 *      PersistentRequestModified)
 	 * @param persistentRequestModified
 	 *            The “PersistentRequestModified” message
 	 */
@@ -564,6 +594,7 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that a “PutSuccessful” message was received.
 	 * 
+	 * @see FcpListener#receivedPutSuccessful(FcpConnection, PutSuccessful)
 	 * @param putSuccessful
 	 *            The “PutSuccessful” message
 	 */
@@ -576,6 +607,7 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that a “PutFetchable” message was received.
 	 * 
+	 * @see FcpListener#receivedPutFetchable(FcpConnection, PutFetchable)
 	 * @param putFetchable
 	 *            The “PutFetchable” message
 	 */
@@ -588,6 +620,7 @@ public class FcpConnection {
 	/**
 	 * Notifies all listeners that a “ProtocolError” message was received.
 	 * 
+	 * @see FcpListener#receivedProtocolError(FcpConnection, ProtocolError)
 	 * @param protocolError
 	 *            The “ProtocolError” message
 	 */