fix documentation
authorDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Wed, 9 Apr 2008 14:25:42 +0000 (14:25 +0000)
committerDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Wed, 9 Apr 2008 14:25:42 +0000 (14:25 +0000)
git-svn-id: http://trooper/svn/projects/jSite/trunk@668 c3eda9e8-030b-0410-8277-bc7414b0a119

src/net/pterodactylus/util/fcp/PeerNote.java

index a1a0e35..bac39bd 100644 (file)
@@ -3,7 +3,6 @@
  */
 package net.pterodactylus.util.fcp;
 
-
 /**
  * The “PeerNote” message contains a private note that has been entered for a
  * darknet peer.
@@ -14,7 +13,7 @@ package net.pterodactylus.util.fcp;
 public class PeerNote extends BaseMessage {
 
        /** The type for base64 encoded peer notes. */
-       public static final int NOTE_TYPE_BASE64 = 1;
+       public static final int TYPE_PRIVATE_PEER_NOTE = 1;
 
        /**
         * Creates a “PeerNote” message that wraps the recevied message.
@@ -27,8 +26,7 @@ public class PeerNote extends BaseMessage {
        }
 
        /**
-        * Returns the note text in whatever format is specified by
-        * {@link #getPeerNoteType()}.
+        * Returns the base64-encoded note text.
         * 
         * @return The note text
         */
@@ -37,8 +35,7 @@ public class PeerNote extends BaseMessage {
        }
 
        /**
-        * Returns the type of the peer note. The type <code>1</code> means that
-        * the text of the note is base64-encoded.
+        * Returns the type of the peer note.
         * 
         * @return The type of the peer note
         * @throws NumberFormatException