I2P_Developers/i2p.itoopie
3
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

javadoc cleanup to remove those damn warnings

Browse Source
This commit is contained in:
jrandom
2004-04-08 09:07:53 +00:00
committed by zzz
parent 6f0d0bed0b
commit be13c14376
16 changed files with 50 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
apps/i2ptunnel/java/src/net/i2p/i2ptunnel/I2PTunnel.java
View File

@ -252,7 +252,7 @@ public class I2PTunnel implements Logging, EventDispatcher {
/**
* Run the server pointing at the host and port specified using the private i2p
* destination loaded from the specified file
* destination loaded from the specified file. <p />
*
* Sets the event "serverTaskId" = Integer(taskId) after the tunnel has been started (or -1 on error)
* Also sets the event "openServerResult" = "ok" or "error" (displaying "Ready!" on the logger after
@ -307,7 +307,7 @@ public class I2PTunnel implements Logging, EventDispatcher {
/**
* Run the server pointing at the host and port specified using the private i2p
* destination loaded from the given base64 stream
* destination loaded from the given base64 stream. <p />
*
* Sets the event "serverTaskId" = Integer(taskId) after the tunnel has been started (or -1 on error)
* Also sets the event "openServerResult" = "ok" or "error" (displaying "Ready!" on the logger after
@ -353,7 +353,7 @@ public class I2PTunnel implements Logging, EventDispatcher {
/**
* Run the client on the given port number pointing at the specified destination
* (either the base64 of the destination or file:fileNameContainingDestination)
* (either the base64 of the destination or file:fileNameContainingDestination).
*
* Sets the event "clientTaskId" = Integer(taskId) after the tunnel has been started (or -1 on error)
* Also sets the event "openClientResult" = "error" or "ok" (before setting the value to "ok" it also

5
apps/i2ptunnel/java/src/net/i2p/i2ptunnel/I2PTunnelRunner.java
View File

@ -62,8 +62,9 @@ public class I2PTunnelRunner extends Thread {
public boolean isFinished() { return finished; }
/**
* When was the last data for this runner sent or received? (-1 if no data
* has been transferred yet)
* When was the last data for this runner sent or received?
*
* @return date (ms since the epoch), or -1 if no data has been transferred yet
*
*/
public long getLastActivityOn() { return lastActivityOn; }

2
core/java/src/net/i2p/client/ATalk.java
View File

@ -225,7 +225,7 @@ public class ATalk implements I2PSessionListener, Runnable {
/** I2PSessionListener.messageAvailable requires this method to be called whenever
* I2P wants to tell the session that a message is available. ATalk always grabs
* the message immediately and either processes it as a "send file" command (passing
* it off to {@link #handleRecieveFile handleRecieveFile}) or simply displays the
* it off to handleRecieveFile(..) or simply displays the
* message to the user.
*
*/

4
core/java/src/net/i2p/client/I2PSession.java
View File

@ -32,7 +32,9 @@ public interface I2PSession {
public boolean sendMessage(Destination dest, byte[] payload) throws I2PSessionException;
/**
* Like sendMessage above, except the key used and the tags sent are exposed to the
* application, so that if some application layer message delivery confirmation is used,
* application. <p />
*
* If some application layer message delivery confirmation is used,
* rather than i2p's (slow) built in confirmation via guaranteed delivery mode, the
* application can update the SessionKeyManager, ala:
* <pre>

2
core/java/src/net/i2p/client/TestServer.java
View File

@ -55,7 +55,7 @@ public class TestServer implements Runnable {
}
/**
* Handle the connection by passing it off to a {@link ConnectionRunner ConnectionRunner}
* Handle the connection by passing it off to a ConnectionRunner
*
*/
protected void runConnection(Socket socket) throws IOException {

3
core/java/src/net/i2p/crypto/AESEngine.java
View File

@ -23,8 +23,7 @@ import java.io.ByteArrayInputStream;
* Wrapper singleton for AES cypher operation.
*
* @author jrandom
* @license GPL
*/
*/
public class AESEngine {
private final static Log _log = new Log(AESEngine.class);
private static AESEngine _engine;

3
core/java/src/net/i2p/crypto/CryptixAESEngine.java
View File

@ -20,8 +20,7 @@ import net.i2p.util.Log;
* Only supports data of size mod 16 bytes - no inherent padding.
*
* @author jrandom, thecrypto
* @license GPL
*/
*/
public class CryptixAESEngine extends AESEngine {
private final static Log _log = new Log(CryptixAESEngine.class);
private final static CryptixRijndael_Algorithm _algo = new CryptixRijndael_Algorithm();

1
core/java/src/net/i2p/crypto/DummyElGamalEngine.java
View File

@ -21,7 +21,6 @@ import net.i2p.util.Log;
* Fake ElG E and D, useful for when performance isn't being tested
*
* @author jrandom
* @license GPL
*/
public class DummyElGamalEngine extends ElGamalEngine {
private final static Log _log = new Log(DummyElGamalEngine.class);

19
core/java/src/net/i2p/data/DataHelper.java
View File

@ -338,9 +338,10 @@ public class DataHelper {
/**
* Helper util to compare two objects, treating (null == null) as true, and
* (null == (!null)) as false.
* Helper util to compare two objects, including null handling.
* <p />
*
* This treats (null == null) as true, and (null == (!null)) as false.
*/
public final static boolean eq(Object lhs, Object rhs) {
try {
@ -353,8 +354,12 @@ public class DataHelper {
}
}
/**
* Deep compare two collections, treating (null == null) as true,
* (null == (!null)) as false, and then comparing each element via eq(object, object).
* Run a deep comparison across the two collections.
* <p />
*
* This treats (null == null) as true, (null == (!null)) as false, and then
* comparing each element via eq(object, object). <p />
*
* If the size of the collections are not equal, the comparison returns false.
* The collection order should be consistent, as this simply iterates across both and compares
* based on the value of each at each step along the way.
@ -373,8 +378,10 @@ public class DataHelper {
}
/**
* Compare the byte arrays byte by byte, treating (null == null) as
* true, (null == (!null)) as false, and unequal length arrays as false.
* Run a comparison on the byte arrays, byte by byte. <p />
*
* This treats (null == null) as true, (null == (!null)) as false,
* and unequal length arrays as false.
*
*/
public final static boolean eq(byte lhs[], byte rhs[]) {

2
core/java/src/net/i2p/data/Payload.java
View File

@ -16,7 +16,7 @@ import net.i2p.util.Log;
/**
* Defines the actual payload of a message being delivered, including the
* standard encryption wrapping, as defined by the I2P data structure spec.<p />
* standard encryption wrapping, as defined by the I2P data structure spec.
*
* @author jrandom
*/

2
core/java/src/net/i2p/data/RouterAddress.java
View File

@ -39,7 +39,7 @@ public class RouterAddress extends DataStructureImpl {
/**
* Retrieve the weighted cost of this address, relative to other methods of
* contacting this router. 0 means free and 255 means really expensive.
* contacting this router. The value 0 means free and 255 means really expensive.
* No value above 255 is allowed.
*
*/

3
core/java/src/net/i2p/data/TunnelId.java
View File

@ -41,8 +41,7 @@ public class TunnelId extends DataStructureImpl {
public void setTunnelId(long id) { _tunnelId = id; }
/**
* contains the metadata for the tunnel - is it inbound, outbound, or a participant?
* This data point is kept in memory only and is useful for the router.
* is this tunnel inbound, outbound, or a participant (kept in memory only and used only for the router).s
*
* @return type of tunnel (per constants TYPE_UNSPECIFIED, TYPE_INBOUND, TYPE_OUTBOUND, TYPE_PARTICIPANT)
*/

3
core/java/src/net/i2p/data/i2cp/I2CPMessageImpl.java
View File

@ -28,8 +28,7 @@ public abstract class I2CPMessageImpl extends DataStructureImpl implements I2CPM
public I2CPMessageImpl() {}
/**
* Validate the type and size of the message. and then read the message
* into the data structures.
* Validate the type and size of the message, and then read the message into the data structures. <p />
*
*/
public void readMessage(InputStream in) throws I2CPMessageException, IOException {

26
core/java/src/net/i2p/stat/Rate.java
View File

@ -93,8 +93,8 @@ public class Rate {
/**
* Create a new rate and load its state from the properties, taking data
* from the data points underneath the given prefix (e.g. prefix =
* "profile.dbIntroduction.60m", this will load the associated data points such
* from the data points underneath the given prefix. <p />
* (e.g. prefix = "profile.dbIntroduction.60m", this will load the associated data points such
* as "profile.dbIntroduction.60m.lifetimeEventCount"). The data can be exported
* through store(outputStream, "profile.dbIntroduction.60m").
*
@ -189,7 +189,7 @@ public class Rate {
* During the last period, how much of the time was spent actually processing events in proportion
* to how many events could have occurred if there were no intervals?
*
* If this statistic doesn't use event times, this returns 0.
* @return percentage, or 0 if event times aren't used
*/
public double getLastEventSaturation() {
if ( (_lastEventCount > 0) && (_lastTotalEventTime > 0) ) {
@ -203,10 +203,10 @@ public class Rate {
}
/**
* During the extreme period, how much of the time was spent actually processing events in proportion
* to how many events could have occurred if there were no intervals?
* During the extreme period, how much of the time was spent actually processing events
* in proportion to how many events could have occurred if there were no intervals?
*
* If this statistic doesn't use event times, this returns 0.
* @return percentage, or 0 if the statistic doesn't use event times
*/
public double getExtremeEventSaturation() {
if ( (_extremeEventCount > 0) && (_extremeTotalEventTime > 0) ) {
@ -220,9 +220,9 @@ public class Rate {
/**
* During the lifetime of this stat, how much of the time was spent actually processing events in proportion
* to how many events could have occurred if there were no intervals?
* to how many events could have occurred if there were no intervals?
*
* If this statistic doesn't use event times, this returns 0.
* @return percentage, or 0 if event times aren't used
*/
public double getLifetimeEventSaturation() {
if ( (_lastEventCount > 0) && (_lifetimeTotalEventTime > 0) ) {
@ -244,9 +244,10 @@ public class Rate {
}
/**
* using the last period's rate, what is the total value that could have been sent if events were constant?
* If this statistic's event times are 0, this returns 0.
* using the last period's rate, what is the total value that could have been sent
* if events were constant?
*
* @return max total value, or 0 if event times aren't used
*/
public double getLastSaturationLimit() {
if ( (_lastTotalValue != 0) && (_lastEventCount > 0) && (_lastTotalEventTime > 0) ) {
@ -261,9 +262,10 @@ public class Rate {
}
/**
* using the extreme period's rate, what is the total value that could have been sent if events were constant?
* If this statistic's event times are 0, this returns 0.
* using the extreme period's rate, what is the total value that could have been
* sent if events were constant?
*
* @return event total at saturation, or 0 if no event times are measured
*/
public double getExtremeSaturationLimit() {
if ( (_extremeTotalValue != 0) && (_extremeEventCount > 0) && (_extremeTotalEventTime > 0) ) {

4
router/java/src/net/i2p/router/message/SendReplyMessageJob.java
View File

@ -45,10 +45,10 @@ public class SendReplyMessageJob extends JobImpl {
}
/**
* Send the message on its way.<p />
* Send the message on its way. <p />
*
* This could garlic route the message to the _block.getRouter, or it could
* send it there via a tunnel, or it could just send it direct.<p />
* send it there via a tunnel, or it could just send it direct. <p />
*
* For simplicity, its currently going direct.
*

5
router/java/src/net/i2p/router/peermanager/DBHistory.java
View File

@ -64,7 +64,10 @@ public class DBHistory {
public long getUnpromptedDbStoreNew() { return _unpromptedDbStoreNew; }
/** how many times have they sent us data we didn't ask for but that we have seen? */
public long getUnpromptedDbStoreOld() { return _unpromptedDbStoreOld; }
/** how often does the peer fail to reply to a lookup request? 1 hour and 1 day periods */
/**
* how often does the peer fail to reply to a lookup request, broken into 1 hour and 1 day periods.
*
*/
public RateStat getFailedLookupRate() { return _failedLookupRate; }
/**