This is the mail archive of the
java-patches@gcc.gnu.org
mailing list for the Java project.
Patch: java.nio.charset - javadoc enhancements
- From: Michael Koch <konqueror at gmx dot de>
- To: java-patches at gcc dot gnu dot org
- Date: Thu, 22 Apr 2004 08:42:36 +0200
- Subject: Patch: java.nio.charset - javadoc enhancements
Hi list,
I just commited the attached patch to enhance javadocs in
java.nio.charset.
Michael
2004-04-22 Michael Koch <konqueror@gmx.de>
* java/nio/charset/IllegalCharsetNameException.java
(charsetName): Made private.
(IllegalCharsetNameException): Added @param tag to javadoc.
(getCharsetName): Added @return tag to javadoc.
* java/nio/charset/MalformedInputException.java
(MalformedInputException): Added @param tag to javadoc.
(getInputLength): Revised method description, added @return tag.
(getMessage): Added @return tag.
Index: java/nio/charset/IllegalCharsetNameException.java
===================================================================
RCS file: /cvs/gcc/gcc/libjava/java/nio/charset/IllegalCharsetNameException.java,v
retrieving revision 1.3
diff -u -r1.3 IllegalCharsetNameException.java
--- java/nio/charset/IllegalCharsetNameException.java 11 Feb 2003 06:46:15 -0000 1.3
+++ java/nio/charset/IllegalCharsetNameException.java 22 Apr 2004 06:40:11 -0000
@@ -48,10 +48,12 @@
*/
private static final long serialVersionUID = 1457525358470002989L;
- String charsetName;
+ private String charsetName;
/**
* Creates the exception
+ *
+ * @param charsetName name of the illegal charset
*/
public IllegalCharsetNameException (String charsetName)
{
@@ -61,6 +63,8 @@
/**
* Retrieves the illegal charset name
+ *
+ * @return the illegal charset name
*/
public String getCharsetName ()
{
Index: java/nio/charset/MalformedInputException.java
===================================================================
RCS file: /cvs/gcc/gcc/libjava/java/nio/charset/MalformedInputException.java,v
retrieving revision 1.2
diff -u -r1.2 MalformedInputException.java
--- java/nio/charset/MalformedInputException.java 11 Nov 2002 07:12:07 -0000 1.2
+++ java/nio/charset/MalformedInputException.java 22 Apr 2004 06:40:11 -0000
@@ -46,6 +46,8 @@
/**
* Creates the exception
+ *
+ * @param inputLength the position of malformed input in the input stream
*/
public MalformedInputException (int inputLength)
{
@@ -54,7 +56,9 @@
}
/**
- * Retrieves the illegal charset name
+ * Retrieves the position of the malformed input in the input stream.
+ *
+ * @return the position
*/
public int getInputLength ()
{
@@ -63,6 +67,8 @@
/**
* Returns the detail message string of this throwable
+ *
+ * @return the message
*/
public String getMessage ()
{