This is the mail archive of the
java-patches@gcc.gnu.org
mailing list for the Java project.
Documentation in java.net.*
- From: Michael Koch <konqueror at gmx dot de>
- To: java-patches at gcc dot gnu dot org
- Date: Mon, 2 Sep 2002 11:20:20 +0200
- Subject: Documentation in java.net.*
hello list,
I have commited the attached patch to re-indent some method documentations.
Michael
Index: ChangeLog
===================================================================
RCS file: /cvs/gcc/gcc/libjava/ChangeLog,v
retrieving revision 1.1425
diff -u -b -r1.1425 ChangeLog
--- ChangeLog 31 Aug 2002 05:27:15 -0000 1.1425
+++ ChangeLog 2 Sep 2002 09:18:17 -0000
@@ -1,3 +1,8 @@
+2002-09-02 Michael Koch <konqueror@gmx.de>
+
+ * java/net/DatagramPacket.java, java/net/MulticsstSocket.java:
+ re-indented documentation.
+
2002-08-30 Jesse Rosenstock <jmr@ugcs.caltech.edu>
* java/util/Calendar.java (getTimeInMillis, getTimeInMillis): Now
Index: java/net/MulticastSocket.java
===================================================================
RCS file: /cvs/gcc/gcc/libjava/java/net/MulticastSocket.java,v
retrieving revision 1.11
diff -u -b -r1.11 MulticastSocket.java
--- java/net/MulticastSocket.java 27 Aug 2002 17:47:27 -0000 1.11
+++ java/net/MulticastSocket.java 2 Sep 2002 09:18:17 -0000
@@ -39,7 +39,7 @@
import java.io.IOException;
-/*
+/**
* Written using on-line Java Platform 1.2 API Specification, as well
* as "The Java Class Libraries", 2nd edition (Addison-Wesley, 1998).
* Status: Believed complete and correct.
@@ -69,7 +69,7 @@
// unlike unicast sockets. It binds to any available network interface.
// See p.1159 JCL book.
-/**
+ /**
* Create a MulticastSocket that this not bound to any address
*
* @exception IOException If an error occurs
@@ -79,10 +79,10 @@
super(0, null);
}
-/**
+ /**
* Create a multicast socket bound to the specified port
*
- * @param The port to bind to
+ * @param port The port to bind to
*
* @exception IOException If an error occurs
*/
@@ -91,7 +91,7 @@
super(port, null);
}
-/**
+ /**
* Returns the interface being used for multicast packets
*
* @return The multicast interface
@@ -104,7 +104,7 @@
return (InetAddress) impl.getOption(SocketOptions.IP_MULTICAST_IF);
}
-/**
+ /**
* Returns the current value of the "Time to Live" option. This is the
* number of hops a packet can make before it "expires". This method id
* deprecated. Use <code>getTimeToLive</code> instead.
@@ -113,7 +113,7 @@
*
* @exception IOException If an error occurs
*
- * @deprecated Replaced by getTimeToLive() in Java 1.2
+ * @deprecated 1.2 Replaced by getTimeToLive()
*/
public byte getTTL() throws IOException
{
@@ -123,7 +123,7 @@
return impl.getTTL();
}
-/**
+ /**
* Returns the current value of the "Time to Live" option. This is the
* number of hops a packet can make before it "expires".
*
@@ -131,17 +131,17 @@
*
* @exception IOException If an error occurs
*
- * @since Java 1.2
+ * @since 1.2
*/
public int getTimeToLive() throws IOException
{
return impl.getTimeToLive();
}
-/**
- * Sets the interface to use for multicast packets.
+ /**
+ * Sets the interface to use for sending multicast packets.
*
- * @param addr The new interface to use
+ * @param inf The new interface to use
*
* @exception SocketException If an error occurs
*/
@@ -150,7 +150,7 @@
impl.setOption(SocketOptions.IP_MULTICAST_IF, inf);
}
-/**
+ /**
* Sets the "Time to Live" value for a socket. The value must be between
* 1 and 255.
*
@@ -158,7 +158,7 @@
*
* @exception IOException If an error occurs
*
- * @deprecated Replaced by <code>setTimeToLive</code> in Java 1.2
+ * @deprecated 1.2 Replaced by <code>setTimeToLive</code>
*/
public void setTTL(byte ttl) throws IOException
{
@@ -168,7 +168,7 @@
impl.setTTL(ttl);
}
-/**
+ /**
* Sets the "Time to Live" value for a socket. The value must be between
* 1 and 255.
*
@@ -176,7 +176,7 @@
*
* @exception IOException If an error occurs
*
- * @since Java 1.2
+ * @since 1.2
*/
public void setTimeToLive(int ttl) throws IOException
{
@@ -186,7 +186,7 @@
impl.setTimeToLive(ttl);
}
-/**
+ /**
* Joins the specified mulitcast group.
*
* @param addr The address of the group to join
@@ -205,7 +205,7 @@
impl.join(mcastaddr);
}
-/**
+ /**
* Leaves the specified multicast group
*
* @param addr The address of the group to leave
@@ -224,7 +224,7 @@
impl.leave(mcastaddr);
}
-/**
+ /**
* Sends a packet of data to a multicast address with a TTL that is
* different from the default TTL on this socket. The default TTL for
* the socket is not changed.
Index: java/net/DatagramPacket.java
===================================================================
RCS file: /cvs/gcc/gcc/libjava/java/net/DatagramPacket.java,v
retrieving revision 1.8
diff -u -b -r1.8 DatagramPacket.java
--- java/net/DatagramPacket.java 29 Aug 2002 18:44:42 -0000 1.8
+++ java/net/DatagramPacket.java 2 Sep 2002 09:18:17 -0000
@@ -65,37 +65,36 @@
* @author Aarom M. Renn (arenn@urbanophile.com) (Documentation comments)
* @date April 28, 1999.
*/
-
public final class DatagramPacket
{
-/**
+ /**
* The data buffer to send
*/
private byte[] buffer;
-/**
+ /**
* This is the offset into the buffer to start sending from or receiving to.
*/
private int offset;
-/**
+ /**
* The length of the data buffer to send
*/
private int length;
-/**
+ /**
* The address to which the packet should be sent or from which it
* was received
*/
private InetAddress address;
-/**
+ /**
* The port to which the packet should be sent or from which it was
* was received.
*/
private int port;
-/**
+ /**
* This method initializes a new instance of <code>DatagramPacket</code>
* which has the specified buffer, offset, and length.
*
@@ -124,7 +123,7 @@
this.port = -1;
}
-/**
+ /**
* Initializes a new instance of <code>DatagramPacket</code> for
* receiving packets from the network.
*
@@ -136,7 +135,7 @@
this(buf, 0, length);
}
-/**
+ /**
* Initializes a new instance of <code>DatagramPacket</code> for
* transmitting packets across the network.
*
@@ -172,7 +171,7 @@
this.port = port;
}
-/**
+ /**
* Initializes a new instance of <code>DatagramPacket</code> for
* transmitting packets across the network.
*
@@ -225,7 +224,7 @@
((InetSocketAddress)address).getPort());
}
-/**
+ /**
* Returns the address that this packet is being sent to or, if it was used
* to receive a packet, the address that is was received from. If the
* constructor that doesn not take an address was used to create this object
@@ -239,7 +238,7 @@
return address;
}
-/**
+ /**
* Returns the port number this packet is being sent to or, if it was used
* to receive a packet, the port that it was received from. If the
* constructor that doesn not take an address was used to create this object
@@ -253,7 +252,7 @@
return port;
}
-/**
+ /**
* Returns the data buffer for this packet
*
* @return This packet's data buffer
@@ -263,7 +262,7 @@
return buffer;
}
-/**
+ /**
* This method returns the current offset value into the data buffer
* where data will be sent from.
*
@@ -276,7 +275,7 @@
return offset;
}
-/**
+ /**
* Returns the length of the data in the buffer
*
* @return The length of the data
@@ -286,7 +285,7 @@
return length;
}
-/**
+ /**
* This sets the address to which the data packet will be transmitted.
*
* @param addr The destination address
@@ -301,7 +300,7 @@
address = iaddr;
}
-/**
+ /**
* This sets the port to which the data packet will be transmitted.
*
* @param port The destination port
@@ -348,7 +347,7 @@
return new InetSocketAddress (address, port);
}
-/**
+ /**
* Sets the data buffer for this packet.
*
* @param buf The new buffer for this packet
@@ -365,7 +364,7 @@
buffer = buf;
}
-/**
+ /**
* This method sets the data buffer for the packet.
*
* @param buf The byte array containing the data for this packet.
@@ -393,7 +392,7 @@
this.length = length;
}
-/**
+ /**
* Sets the length of the data in the buffer.
*
* @param length The new length. (Where len <= buf.length)