Changeset be13c14


Ignore:
Timestamp:
Apr 8, 2004 9:07:53 AM (17 years ago)
Author:
zzz <zzz@…>
Branches:
master
Children:
e8a2130
Parents:
6f0d0be
git-author:
jrandom <jrandom> (04/08/04 09:07:53)
git-committer:
zzz <zzz@…> (04/08/04 09:07:53)
Message:

javadoc cleanup to remove those damn warnings

Files:
16 edited

Legend:

Unmodified
Added
Removed
  • apps/i2ptunnel/java/src/net/i2p/i2ptunnel/I2PTunnel.java

    r6f0d0be rbe13c14  
    253253    /**
    254254     * Run the server pointing at the host and port specified using the private i2p
    255      * destination loaded from the specified file
     255     * destination loaded from the specified file. <p />
    256256     *
    257257     * Sets the event "serverTaskId" = Integer(taskId) after the tunnel has been started (or -1 on error)
     
    308308    /**
    309309     * Run the server pointing at the host and port specified using the private i2p
    310      * destination loaded from the given base64 stream
     310     * destination loaded from the given base64 stream. <p />
    311311     *
    312312     * Sets the event "serverTaskId" = Integer(taskId) after the tunnel has been started (or -1 on error)
     
    354354    /**
    355355     * Run the client on the given port number pointing at the specified destination
    356      * (either the base64 of the destination or file:fileNameContainingDestination)
     356     * (either the base64 of the destination or file:fileNameContainingDestination).
    357357     *
    358358     * Sets the event "clientTaskId" = Integer(taskId) after the tunnel has been started (or -1 on error)
  • apps/i2ptunnel/java/src/net/i2p/i2ptunnel/I2PTunnelRunner.java

    r6f0d0be rbe13c14  
    6363   
    6464    /**
    65      * When was the last data for this runner sent or received?  (-1 if no data
    66      * has been transferred yet)
     65     * When was the last data for this runner sent or received? 
     66     *
     67     * @return date (ms since the epoch), or -1 if no data has been transferred yet
    6768     *
    6869     */
  • core/java/src/net/i2p/client/ATalk.java

    r6f0d0be rbe13c14  
    226226     * I2P wants to tell the session that a message is available.  ATalk always grabs
    227227     * the message immediately and either processes it as a "send file" command (passing
    228      * it off to {@link #handleRecieveFile handleRecieveFile}) or simply displays the
     228     * it off to handleRecieveFile(..) or simply displays the
    229229     * message to the user.
    230230     *
  • core/java/src/net/i2p/client/I2PSession.java

    r6f0d0be rbe13c14  
    3333    /**
    3434     * Like sendMessage above, except the key used and the tags sent are exposed to the
    35      * application, so that if some application layer message delivery confirmation is used,
     35     * application.  <p />
     36     *
     37     * If some application layer message delivery confirmation is used,
    3638     * rather than i2p's (slow) built in confirmation via guaranteed delivery mode, the
    3739     * application can update the SessionKeyManager, ala:
  • core/java/src/net/i2p/client/TestServer.java

    r6f0d0be rbe13c14  
    5656   
    5757    /**
    58      * Handle the connection by passing it off to a {@link ConnectionRunner ConnectionRunner}
     58     * Handle the connection by passing it off to a ConnectionRunner
    5959     *
    6060     */
  • core/java/src/net/i2p/crypto/AESEngine.java

    r6f0d0be rbe13c14  
    2424 *
    2525 * @author jrandom
    26  * @license GPL
    27  */
     26  */
    2827public class AESEngine {
    2928    private final static Log _log = new Log(AESEngine.class);
  • core/java/src/net/i2p/crypto/CryptixAESEngine.java

    r6f0d0be rbe13c14  
    2121 *
    2222 * @author jrandom, thecrypto
    23  * @license GPL
    24  */
     23  */
    2524public class CryptixAESEngine extends AESEngine {
    2625    private final static Log _log = new Log(CryptixAESEngine.class);
  • core/java/src/net/i2p/crypto/DummyElGamalEngine.java

    r6f0d0be rbe13c14  
    2222 *
    2323 * @author jrandom
    24  * @license GPL
    2524 */
    2625public class DummyElGamalEngine extends ElGamalEngine {
  • core/java/src/net/i2p/data/DataHelper.java

    r6f0d0be rbe13c14  
    339339   
    340340    /**
    341      * Helper util to compare two objects, treating (null == null) as true, and
    342      * (null == (!null)) as false.
    343      *
     341     * Helper util to compare two objects, including null handling.
     342     * <p />
     343     *
     344     * This treats (null == null) as true, and (null == (!null)) as false.
    344345     */
    345346    public final static boolean eq(Object lhs, Object rhs) {
     
    354355    }
    355356    /**
    356      * Deep compare two collections, treating (null == null) as true,
    357      * (null == (!null)) as false, and then comparing each element via eq(object, object).
     357     * Run a deep comparison across the two collections. 
     358     * <p />
     359     *
     360     * This treats (null == null) as true, (null == (!null)) as false, and then
     361     * comparing each element via eq(object, object). <p />
     362     *
    358363     * If the size of the collections are not equal, the comparison returns false.
    359364     * The collection order should be consistent, as this simply iterates across both and compares
     
    374379   
    375380    /**
    376      * Compare the byte arrays byte by byte, treating (null == null) as
    377      * true, (null == (!null)) as false, and unequal length arrays as false.
     381     * Run a comparison on the byte arrays, byte by byte.  <p />
     382     *
     383     * This treats (null == null) as true, (null == (!null)) as false,
     384     * and unequal length arrays as false.
    378385     *
    379386     */
  • core/java/src/net/i2p/data/Payload.java

    r6f0d0be rbe13c14  
    1717/**
    1818 * Defines the actual payload of a message being delivered, including the
    19  * standard encryption wrapping, as defined by the I2P data structure spec.<p />
     19 * standard encryption wrapping, as defined by the I2P data structure spec.
    2020 *
    2121 * @author jrandom
  • core/java/src/net/i2p/data/RouterAddress.java

    r6f0d0be rbe13c14  
    4040    /**
    4141     * Retrieve the weighted cost of this address, relative to other methods of
    42      * contacting this router.  0 means free and 255 means really expensive.
     42     * contacting this router.  The value 0 means free and 255 means really expensive.
    4343     * No value above 255 is allowed.
    4444     *
  • core/java/src/net/i2p/data/TunnelId.java

    r6f0d0be rbe13c14  
    4242   
    4343    /**
    44      * contains the metadata for the tunnel - is it inbound, outbound, or a participant?
    45      * This data point is kept in memory only and is useful for the router.
     44     * is this tunnel inbound, outbound, or a participant (kept in memory only and used only for the router).s
    4645     *
    4746     * @return type of tunnel (per constants TYPE_UNSPECIFIED, TYPE_INBOUND, TYPE_OUTBOUND, TYPE_PARTICIPANT)
  • core/java/src/net/i2p/data/i2cp/I2CPMessageImpl.java

    r6f0d0be rbe13c14  
    2929   
    3030    /**
    31      * Validate the type and size of the message. and then read the message
    32      * into the data structures.
     31     * Validate the type and size of the message, and then read the message into the data structures.  <p />
    3332     *
    3433     */
  • core/java/src/net/i2p/stat/Rate.java

    r6f0d0be rbe13c14  
    9494    /**
    9595     * Create a new rate and load its state from the properties, taking data
    96      * from the data points underneath the given prefix (e.g. prefix =
    97      * "profile.dbIntroduction.60m", this will load the associated data points such
     96     * from the data points underneath the given prefix.  <p />
     97     * (e.g. prefix = "profile.dbIntroduction.60m", this will load the associated data points such
    9898     * as "profile.dbIntroduction.60m.lifetimeEventCount").  The data can be exported
    9999     * through store(outputStream, "profile.dbIntroduction.60m").
     
    190190     * to how many events could have occurred if there were no intervals?
    191191     *
    192      * If this statistic doesn't use event times, this returns 0.
     192     * @return percentage, or 0 if event times aren't used
    193193     */
    194194    public double getLastEventSaturation() {
     
    204204   
    205205    /**
    206      * During the extreme period, how much of the time was spent actually processing events in proportion
    207      * to how many events could have occurred if there were no intervals?
    208      *
    209      * If this statistic doesn't use event times, this returns 0.
     206     * During the extreme period, how much of the time was spent actually processing events
     207     * in proportion to how many events could have occurred if there were no intervals?
     208     *
     209     * @return percentage, or 0 if the statistic doesn't use event times
    210210     */
    211211    public double getExtremeEventSaturation() {
     
    221221    /**
    222222     * During the lifetime of this stat, how much of the time was spent actually processing events in proportion
    223      * to how many events could have occurred if there were no intervals?
    224      *
    225      * If this statistic doesn't use event times, this returns 0.
     223     * to how many events could have occurred if there were no intervals? 
     224     *
     225     * @return percentage, or 0 if event times aren't used
    226226     */
    227227    public double getLifetimeEventSaturation() {
     
    245245   
    246246    /**
    247      * using the last period's rate, what is the total value that could have been sent if events were constant?
    248      * If this statistic's event times are 0, this returns 0.
    249      *
     247     * using the last period's rate, what is the total value that could have been sent
     248     * if events were constant?
     249     *
     250     * @return max total value, or 0 if event times aren't used
    250251     */
    251252    public double getLastSaturationLimit() {
     
    262263   
    263264    /**
    264      * using the extreme period's rate, what is the total value that could have been sent if events were constant?
    265      * If this statistic's event times are 0, this returns 0.
    266      *
     265     * using the extreme period's rate, what is the total value that could have been
     266     * sent if events were constant?
     267     *
     268     * @return event total at saturation, or 0 if no event times are measured
    267269     */
    268270    public double getExtremeSaturationLimit() {
  • router/java/src/net/i2p/router/message/SendReplyMessageJob.java

    r6f0d0be rbe13c14  
    4646   
    4747    /**
    48      * Send the message on its way.<p />
     48     * Send the message on its way. <p />
    4949     *
    5050     * This could garlic route the message to the _block.getRouter, or it could
    51      * send it there via a tunnel, or it could just send it direct.<p />
     51     * send it there via a tunnel, or it could just send it direct. <p />
    5252     *
    5353     * For simplicity, its currently going direct.
  • router/java/src/net/i2p/router/peermanager/DBHistory.java

    r6f0d0be rbe13c14  
    6565    /** how many times have they sent us data we didn't ask for but that we have seen? */
    6666    public long getUnpromptedDbStoreOld() { return _unpromptedDbStoreOld; }
    67     /** how often does the peer fail to reply to a lookup request?  1 hour and 1 day periods */
     67    /**
     68     * how often does the peer fail to reply to a lookup request, broken into 1 hour and 1 day periods.
     69     *
     70     */
    6871    public RateStat getFailedLookupRate() { return _failedLookupRate; }
    6972
Note: See TracChangeset for help on using the changeset viewer.