From 65d415fade70026ac2ea160be1a6400ed73052ae Mon Sep 17 00:00:00 2001
From: jrandom <jrandom>
Date: Sat, 30 Oct 2004 23:58:50 +0000
Subject: [PATCH] javadoc fixes

---
 .../net/i2p/client/streaming/Connection.java  |  8 ++--
 .../client/streaming/MessageOutputStream.java |  2 +-
 .../src/net/i2p/client/streaming/Packet.java  | 40 +++++++++----------
 .../client/streaming/SchedulerConnecting.java |  2 +-
 4 files changed, 26 insertions(+), 26 deletions(-)

diff --git a/apps/streaming/java/src/net/i2p/client/streaming/Connection.java b/apps/streaming/java/src/net/i2p/client/streaming/Connection.java
index 789258f92..e0163f16b 100644
--- a/apps/streaming/java/src/net/i2p/client/streaming/Connection.java
+++ b/apps/streaming/java/src/net/i2p/client/streaming/Connection.java
@@ -318,7 +318,7 @@ public class Connection {
     public byte[] getSendStreamId() { return _sendStreamId; }
     public void setSendStreamId(byte[] id) { _sendStreamId = id; }
     
-    /** what stream does the peer send data to us on? (may be null) */
+    /** stream the peer sends data to us on. (may be null) */
     public byte[] getReceiveStreamId() { return _receiveStreamId; }
     public void setReceiveStreamId(byte[] id) { _receiveStreamId = id; }
     
@@ -343,9 +343,9 @@ public class Connection {
     public ConnectionPacketHandler getPacketHandler() { return _handler; }
     
     /** 
-     * when does the scheduler next want to send a packet?   -1 if never.
-     * This should be set when we want to send on timeout, for instance, or
-     * want to delay an ACK.
+     * Time when the scheduler next want to send a packet, or -1 if 
+     * never.  This should be set when we want to send on timeout, for 
+     * instance, or want to delay an ACK.
      */
     public long getNextSendTime() { return _nextSendTime; }
     public void setNextSendTime(long when) { 
diff --git a/apps/streaming/java/src/net/i2p/client/streaming/MessageOutputStream.java b/apps/streaming/java/src/net/i2p/client/streaming/MessageOutputStream.java
index 784a8de7b..10e43c25a 100644
--- a/apps/streaming/java/src/net/i2p/client/streaming/MessageOutputStream.java
+++ b/apps/streaming/java/src/net/i2p/client/streaming/MessageOutputStream.java
@@ -191,7 +191,7 @@ public class MessageOutputStream extends OutputStream {
          * which we throttle rather than accept arbitrary data and queue 
          */
         public void waitForAccept(int maxWaitMs);
-        /** was the write accepted?  aka did the socket not close? */
+        /** the write was accepted.  aka did the socket not close? */
         public boolean writeAccepted();
         /** did the write fail?  */
         public boolean writeFailed();
diff --git a/apps/streaming/java/src/net/i2p/client/streaming/Packet.java b/apps/streaming/java/src/net/i2p/client/streaming/Packet.java
index 7df101e09..9a475d3ee 100644
--- a/apps/streaming/java/src/net/i2p/client/streaming/Packet.java
+++ b/apps/streaming/java/src/net/i2p/client/streaming/Packet.java
@@ -11,13 +11,13 @@ import net.i2p.data.SigningPrivateKey;
 /**
  * Contain a single packet transferred as part of a streaming connection.  
  * The data format is as follows:<ul>
- * <li>{@see #getSendStreamId sendStreamId} [4 byte value]</li>
- * <li>{@see #getReceiveStreamId receiveStreamId} [4 byte value]</li>
- * <li>{@see #getSequenceNum sequenceNum} [4 byte unsigned integer]</li>
- * <li>{@see #getAckThrough ackThrough} [4 byte unsigned integer]</li>
+ * <li>{@link #getSendStreamId sendStreamId} [4 byte value]</li>
+ * <li>{@link #getReceiveStreamId receiveStreamId} [4 byte value]</li>
+ * <li>{@link #getSequenceNum sequenceNum} [4 byte unsigned integer]</li>
+ * <li>{@link #getAckThrough ackThrough} [4 byte unsigned integer]</li>
  * <li>number of NACKs [1 byte unsigned integer]</li>
- * <li>that many {@see #getNacks NACKs}</li>
- * <li>{@see #getResendDelay resendDelay} [1 byte integer]</li>
+ * <li>that many {@link #getNacks NACKs}</li>
+ * <li>{@link #getResendDelay resendDelay} [1 byte integer]</li>
  * <li>flags [2 byte value]</li>
  * <li>option data size [2 byte integer]</li>
  * <li>option data specified by those flags [0 or more bytes]</li>
@@ -28,15 +28,15 @@ import net.i2p.data.SigningPrivateKey;
  * turn may require certain additional data to be included.  The flags are
  * as follows (with any data structures specified added to the options area
  * in the given order):</p><ol>
- * <li>{@see #FLAG_SYNCHRONIZE}: no option data</li>
- * <li>{@see #FLAG_CLOSE}: no option data</li>
- * <li>{@see #FLAG_RESET}: no option data</li>
- * <li>{@see #FLAG_SIGNATURE_INCLUDED}: {@see net.i2p.data.Signature}</li>
- * <li>{@see #FLAG_SIGNATURE_REQUESTED}: no option data</li>
- * <li>{@see #FLAG_FROM_INCLUDED}: {@see net.i2p.data.Destination}</li>
- * <li>{@see #FLAG_DELAY_REQUESTED}: 1 byte integer</li>
- * <li>{@see #FLAG_MAX_PACKET_SIZE_INCLUDED}: 2 byte integer</li>
- * <li>{@see #FLAG_PROFILE_INTERACTIVE}: no option data</li>
+ * <li>{@link #FLAG_SYNCHRONIZE}: no option data</li>
+ * <li>{@link #FLAG_CLOSE}: no option data</li>
+ * <li>{@link #FLAG_RESET}: no option data</li>
+ * <li>{@link #FLAG_SIGNATURE_INCLUDED}: {@link net.i2p.data.Signature}</li>
+ * <li>{@link #FLAG_SIGNATURE_REQUESTED}: no option data</li>
+ * <li>{@link #FLAG_FROM_INCLUDED}: {@link net.i2p.data.Destination}</li>
+ * <li>{@link #FLAG_DELAY_REQUESTED}: 1 byte integer</li>
+ * <li>{@link #FLAG_MAX_PACKET_SIZE_INCLUDED}: 2 byte integer</li>
+ * <li>{@link #FLAG_PROFILE_INTERACTIVE}: no option data</li>
  * </ol>
  *
  * <p>If the signature is included, it uses the Destination's DSA key 
@@ -149,7 +149,7 @@ public class Packet {
     }
     
     /** 
-     * what is the stream replies should be sent on?  if the 
+     * Stream that replies should be sent on.  if the 
      * connection is still being built, this should be 
      * null.
      *
@@ -171,8 +171,8 @@ public class Packet {
     public void setSequenceNum(long num) { _sequenceNum = num; }
     
     /** 
-     * what is the highest packet sequence number that received
-     * on the receiveStreamId?  This field is ignored on the initial
+     * The highest packet sequence number that received
+     * on the receiveStreamId.  This field is ignored on the initial
      * connection packet (where receiveStreamId is the unknown id).
      *
      */
@@ -180,8 +180,8 @@ public class Packet {
     public void setAckThrough(long id) { _ackThrough = id; }
     
     /**
-     * What packet sequence numbers below the getAckThrough() value
-     * have not been received?  this may be null.
+     * List of packet sequence numbers below the getAckThrough() value
+     * have not been received.  this may be null.
      *
      */
     public long[] getNacks() { return _nacks; }
diff --git a/apps/streaming/java/src/net/i2p/client/streaming/SchedulerConnecting.java b/apps/streaming/java/src/net/i2p/client/streaming/SchedulerConnecting.java
index 98fd92cc9..45cfc1d3a 100644
--- a/apps/streaming/java/src/net/i2p/client/streaming/SchedulerConnecting.java
+++ b/apps/streaming/java/src/net/i2p/client/streaming/SchedulerConnecting.java
@@ -19,7 +19,7 @@ import net.i2p.util.Log;
  * </ul>
  *
  * <h2>Next states:</h2>
- * <li>{@link SchedulerConnected connected} - after receiving an ACK</li>
+ * <li>{@link SchedulerConnectedBulk connected} - after receiving an ACK</li>
  * <li>{@link SchedulerClosing closing} - after both sending and receiving a CLOSE</li>
  * <li>{@link SchedulerClosed closed} - after both sending and receiving ACKs on the CLOSE</li>
  * <li>{@link SchedulerDead dead} - after sending or receiving a RESET</li>