BufferedReader.java, [...]: Fixed javadocs all over.

2004-11-16  Michael Koch  <konqueror@gmx.de>

	* java/io/BufferedReader.java,
	java/io/FileInputStream.java,
	java/io/FileOutputStream.java,
	java/io/FileWriter.java,
	java/io/OutputStreamWriter.java,
	java/io/PipedInputStream.java,
	java/io/PipedOutputStream.java,
	java/io/PipedReader.java,
	java/io/PipedWriter.java,
	java/io/PrintStream.java,
	java/io/PushbackInputStream.java,
	java/io/RandomAccessFile.java,
	java/io/Reader.java,
	java/io/StreamTokenizer.java,
	java/io/StringReader.java,
	java/net/NetworkInterface.java,
	java/net/URLClassLoader.java,
	java/nio/ByteOrder.java,
	java/nio/channels/Channel.java:
	Fixed javadocs all over.

From-SVN: r90727
This commit is contained in:
Michael Koch 2004-11-16 11:30:14 +00:00 committed by Michael Koch
parent d39289db5a
commit be06f47bc1
20 changed files with 225 additions and 199 deletions

View file

@ -1,5 +1,5 @@
/* NetworkInterface.java --
Copyright (C) 2002, 2003 Free Software Foundation, Inc.
Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@ -85,14 +85,14 @@ public final class NetworkInterface
}
/**
* Returns all available addresses of the network interface
* Returns all available addresses of the network interface
*
* If a @see SecurityManager is available all addresses are checked
* with @see SecurityManager::checkConnect() if they are available.
* Only <code>InetAddresses</code> are returned where the security manager
* doesn't throw an exception.
* If a @see SecurityManager is available all addresses are checked
* with @see SecurityManager::checkConnect() if they are available.
* Only <code>InetAddresses</code> are returned where the security manager
* doesn't throw an exception.
*
* @return An enumeration of all addresses.
* @return An enumeration of all addresses.
*/
public Enumeration getInetAddresses()
{
@ -122,9 +122,9 @@ public final class NetworkInterface
}
/**
* Returns the display name of the interface
* Returns the display name of the interface
*
* @return The display name of the interface
* @return The display name of the interface
*/
public String getDisplayName()
{
@ -160,12 +160,14 @@ public final class NetworkInterface
}
/**
* Return a network interface by its address
* Return a network interface by its address
*
* @param addr The address of the interface to return
* @param addr The address of the interface to return
*
* @exception SocketException If an error occurs
* @exception NullPointerException If the specified addess is null
* @return the interface, or <code>null</code> if none found
*
* @exception SocketException If an error occurs
* @exception NullPointerException If the specified addess is null
*/
public static NetworkInterface getByInetAddress(InetAddress addr)
throws SocketException
@ -189,9 +191,11 @@ public final class NetworkInterface
}
/**
* Return an <code>Enumeration</code> of all available network interfaces
* Return an <code>Enumeration</code> of all available network interfaces
*
* @exception SocketException If an error occurs
* @return all interfaces
*
* @exception SocketException If an error occurs
*/
public static Enumeration getNetworkInterfaces() throws SocketException
{
@ -204,9 +208,11 @@ public final class NetworkInterface
}
/**
* Checks if the current instance is equal to obj
* Checks if the current instance is equal to obj
*
* @param obj The object to compare with
* @param obj The object to compare with
*
* @return <code>true</code> if equal, <code>false<code> otherwise
*/
public boolean equals(Object obj)
{
@ -219,7 +225,9 @@ public final class NetworkInterface
}
/**
* Returns the hashcode of the current instance
* Returns the hashcode of the current instance
*
* @return the hashcode
*/
public int hashCode()
{
@ -228,7 +236,9 @@ public final class NetworkInterface
}
/**
* Returns a string representation of the interface
* Returns a string representation of the interface
*
* @return the string
*/
public String toString()
{
@ -248,4 +258,4 @@ public final class NetworkInterface
return result;
}
} // class NetworkInterface
}