ChoiceFormat.java: Update comments from Classpath.

2002-06-15  Nathanael Nerode  <neroden@twcny.rr.com>

	* java/text/ChoiceFormat.java: Update comments from Classpath.
	* java/text/ParseException.java (serialVersionUID): New
	field from Classpath.
	* java/text/ParseException.java: Update formatting & comments
	from Classpath.

From-SVN: r54654

2 files changed, 49 insertions, 65 deletions

diff --git a/libjava/java/text/ChoiceFormat.java b/libjava/java/text/ChoiceFormat.java
index 4bb123f..710a725 100644
--- a/libjava/java/text/ChoiceFormat.java
+++ b/libjava/java/text/ChoiceFormat.java
@@ -52,10 +52,10 @@ import java.util.Vector;
  * This sounds complicated, but that is because I did a poor job of
  * explaining it.  Consider the following example:
  * <p>
- * <pre>
- * terminators = { 1, ChoiceFormat.nextDouble(1) }
- * formats = { "file", "files" }
- * </pre>
+ *
+<pre>terminators = { 1, ChoiceFormat.nextDouble(1) }
+formats = { "file", "files" }</pre>
+ *
  * <p>
  * In this case if the actual number tested is one or less, then the word
  * "file" is used as the format value.  If the number tested is greater than
diff --git a/libjava/java/text/ParseException.java b/libjava/java/text/ParseException.java
index 0bbc3d2..20e828e 100644
--- a/libjava/java/text/ParseException.java
+++ b/libjava/java/text/ParseException.java
@@ -1,5 +1,5 @@
-/* ParseException.java -- An error occurred while parsing.
-   Copyright (C) 1998, 1999, 2001 Free Software Foundation, Inc.
+/* ParseException.java -- an error occurred while parsing
+   Copyright (C) 1998, 1999, 2001, 2002 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -7,7 +7,7 @@ GNU Classpath is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2, or (at your option)
 any later version.
- 
+
 GNU Classpath is distributed in the hope that it will be useful, but
 WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
@@ -38,65 +38,49 @@ exception statement from your version. */
 
 package java.text;
 
-/* Written using "Java Class Libraries", 2nd edition, plus online
- * API docs for JDK 1.2 beta from http://www.javasoft.com.
- * Status:  Believed complete and correct.
- */
-
-/**
-  * This exception is thrown when an unexpected error occurs during parsing.
-  *
-  * @version 0.0
-  *
-  * @author Aaron M. Renn (arenn@urbanophile.com)
-  * @author Per Bothner <bothner@cygnus.com>
-  * @date October 25, 1998.
-  */
-public class ParseException extends Exception
-{
-
-/*
- * Instance Variables
- */
-
 /**
-  * This is the position where the error was encountered.
-  */
-private int errorOffset;
-
-/*************************************************************************/
-
-/*
- * Constructors
+ * This exception is thrown when an unexpected error occurs during parsing.
+ *
+ * @author Aaron M. Renn (arenn@urbanophile.com)
+ * @author Per Bothner <bothner@cygnus.com>
+ * @see Format
+ * @see FieldPosition
+ * @status updated to 1.4
  */
-
-/**
-  * This method initializes a new instance of <code>ParseException</code>
-  * with a detailed error message and a error position.
-  *
-  * @param msg The descriptive message describing the error.
-  * @param offset The position where the error was encountered.
-  */
-public
-ParseException(String s, int offset)
-{
-  super(s);
-  
-  errorOffset = offset;
-}
-
-/*************************************************************************/
-
-/**
-  * This method returns the position where the error occurred.
-  * 
-  * @return The position where the error occurred.
-  */
-public int
-getErrorOffset()
+public class ParseException extends Exception
 {
-  return(errorOffset);
-}
-
+  /**
+   * Compatible with JDK 1.1+.
+   */
+  private static final long serialVersionUID = 2703218443322787634L;
+
+  /**
+   * This is the position where the error was encountered.
+   *
+   * @serial the zero-based offset in the string where the error occurred
+   */
+  private final int errorOffset;
+
+  /**
+   * This method initializes a new instance of <code>ParseException</code>
+   * with a detailed error message and a error position.
+   *
+   * @param msg the descriptive message describing the error
+   * @param offset the position where the error was encountered
+   */
+  public ParseException(String s, int offset)
+  {
+    super(s);
+    errorOffset = offset;
+  }
+
+  /**
+   * This method returns the position where the error occurred.
+   *
+   * @return the position where the error occurred
+   */
+  public int getErrorOffset()
+  {
+    return errorOffset;
+  }
 } // class ParseException
-