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

Javadocs cleanup *sigh*

Browse Source
This commit is contained in:
sponge
2009-06-06 06:18:50 +00:00
parent 623f972e8b
commit bef55b25ea
3 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
router/java/src/net/i2p/router/transport/UPnP.java
View File

@ -47,9 +47,11 @@ import org.freenetproject.ForwardPortStatus;
* *
* some code has been borrowed from Limewire : @see com.limegroup.gnutella.UPnPManager * some code has been borrowed from Limewire : @see com.limegroup.gnutella.UPnPManager
* *
* @see http://www.upnp.org/ * @see "http://www.upnp.org/"
* @see http://en.wikipedia.org/wiki/Universal_Plug_and_Play * @see "http://en.wikipedia.org/wiki/Universal_Plug_and_Play"
* */
/*
* TODO: Support multiple IGDs ? * TODO: Support multiple IGDs ?
* TODO: Advertise the node like the MDNS plugin does * TODO: Advertise the node like the MDNS plugin does
* TODO: Implement EventListener and react on ip-change * TODO: Implement EventListener and react on ip-change

3
router/java/src/net/i2p/router/transport/udp/UDPTransport.java
View File

@ -387,7 +387,8 @@ public class UDPTransport extends TransportImpl implements TimedWeightedPriority
* - Much better tracking of troublemakers * - Much better tracking of troublemakers
* - Disable if we have good local address or UPnP * - Disable if we have good local address or UPnP
* *
* @param ip publicly routable IPv4 only * @param from Hash of inbound destination
* @param ourIP publicly routable IPv4 only
* @param ourPort >= 1024 * @param ourPort >= 1024
*/ */
void externalAddressReceived(Hash from, byte ourIP[], int ourPort) { void externalAddressReceived(Hash from, byte ourIP[], int ourPort) {

12
router/java/src/org/xmlpull/v1/XmlPullParser.java
View File

@ -815,7 +815,7 @@ public interface XmlPullParser {
* <a href="http://www.w3.org/TR/REC-xml-names/#ns-using">Namespaces in XML</a> * <a href="http://www.w3.org/TR/REC-xml-names/#ns-using">Namespaces in XML</a>
* specification to "http://www.w3.org/XML/1998/namespace". * specification to "http://www.w3.org/XML/1998/namespace".
* *
* @param zero based index of attribute * @param index zero based index of attribute
* @return attribute namespace, * @return attribute namespace,
* empty string ("") is returned if namesapces processing is not enabled or * empty string ("") is returned if namesapces processing is not enabled or
* namespaces processing is enabled but attribute has no namespace (it has no prefix). * namespaces processing is enabled but attribute has no namespace (it has no prefix).
@ -828,7 +828,7 @@ public interface XmlPullParser {
* Throws an IndexOutOfBoundsException if the index is out of range * Throws an IndexOutOfBoundsException if the index is out of range
* or current event type is not START_TAG. * or current event type is not START_TAG.
* *
* @param zero based index of attribute * @param index zero based index of attribute
* @return attribute name (null is never returned) * @return attribute name (null is never returned)
*/ */
String getAttributeName (int index); String getAttributeName (int index);
@ -840,7 +840,7 @@ public interface XmlPullParser {
* Throws an IndexOutOfBoundsException if the index is out of range * Throws an IndexOutOfBoundsException if the index is out of range
* or current event type is not START_TAG. * or current event type is not START_TAG.
* *
* @param zero based index of attribute * @param index zero based index of attribute
* @return attribute prefix or null if namespaces processing is not enabled. * @return attribute prefix or null if namespaces processing is not enabled.
*/ */
String getAttributePrefix(int index); String getAttributePrefix(int index);
@ -849,7 +849,7 @@ public interface XmlPullParser {
* Returns the type of the specified attribute * Returns the type of the specified attribute
* If parser is non-validating it MUST return CDATA. * If parser is non-validating it MUST return CDATA.
* *
* @param zero based index of attribute * @param index zero based index of attribute
* @return attribute type (null is never returned) * @return attribute type (null is never returned)
*/ */
String getAttributeType(int index); String getAttributeType(int index);
@ -859,7 +859,7 @@ public interface XmlPullParser {
* If parser is non-validating it MUST always return false. * If parser is non-validating it MUST always return false.
* This information is part of XML infoset: * This information is part of XML infoset:
* *
* @param zero based index of attribute * @param index zero based index of attribute
* @return false if attribute was in input * @return false if attribute was in input
*/ */
boolean isAttributeDefault(int index); boolean isAttributeDefault(int index);
@ -876,7 +876,7 @@ public interface XmlPullParser {
* *
* @see #defineEntityReplacementText * @see #defineEntityReplacementText
* *
* @param zero based index of attribute * @param index zero based index of attribute
* @return value of attribute (null is never returned) * @return value of attribute (null is never returned)
*/ */
String getAttributeValue(int index); String getAttributeValue(int index);