MarshalledObject.java, [...]: Fixed javadoc, coding style and argument names all over.

2004-04-20  Michael Koch  <konqueror@gmx.de>

	* java/rmi/MarshalledObject.java,
	java/rmi/Naming.java,
	java/rmi/RemoteException.java,
	java/rmi/activation/ActivationException.java,
	java/rmi/server/ServerCloneException.java,
	java/security/AccessController.java,
	java/security/AlgorithmParameterGenerator.java,
	java/security/AlgorithmParameters.java,
	java/security/CodeSource.java,
	java/security/Identity.java,
	java/security/IdentityScope.java,
	java/security/KeyPairGenerator.java,
	java/security/KeyStore.java,
	java/security/Security.java,
	java/security/Signature.java,
	java/security/SignatureSpi.java,
	java/security/SignedObject.java,
	java/security/spec/DSAParameterSpec.java,
	java/security/spec/DSAPrivateKeySpec.java,
	java/security/spec/DSAPublicKeySpec.java,
	java/sql/Array.java,
	java/sql/DatabaseMetaData.java,
	java/sql/ResultSet.java,
	java/text/ChoiceFormat.java,
	java/text/CollationElementIterator.java,
	java/text/CollationKey.java,
	java/text/Collator.java,
	java/text/DateFormat.java,
	java/text/DateFormatSymbols.java,
	java/text/DecimalFormatSymbols.java,
	java/text/Format.java,
	java/text/ParsePosition.java,
	java/text/RuleBasedCollator.java,
	java/text/SimpleDateFormat.java,
	java/text/StringCharacterIterator.java,
	java/util/Collections.java,
	java/util/PropertyResourceBundle.java,
	java/util/ResourceBundle.java,
	java/util/StringTokenizer.java,
	java/util/jar/Attributes.java,
	java/util/logging/ConsoleHandler.java,
	java/util/logging/LogManager.java,
	java/util/logging/MemoryHandler.java,
	java/util/logging/SocketHandler.java,
	javax/naming/NamingException.java:
	Fixed javadoc, coding style and argument names all over.

From-SVN: r80906

libjava/java/util/Collections.java

@@ -54,7 +54,7 @@ import java.io.Serializable;
  * are not required, to throw the {@link UnsupportedOperationException} that
  * the underlying collection would throw during an attempt at modification.
  * For example,
- * <code>Collections.singleton("").addAll(Collections.EMPTY_SET)<code>
+ * <code>Collections.singleton("").addAll(Collections.EMPTY_SET)</code>
  * does not throw a exception, even though addAll is an unsupported operation
  * on a singleton; the reason for this is that addAll did not attempt to
  * modify the set.

libjava/java/util/PropertyResourceBundle.java

@@ -54,7 +54,7 @@ import java.io.InputStream;
  *
  * If there is also a class for this resource and the same locale, the
  * class will be chosen. The properties file should have the name of the
- * resource bundle, appended with the locale (e.g. <code>_de</code) and the
+ * resource bundle, appended with the locale (e.g. <code>_de</code> and the
  * extension <code>.properties</code>. The file should have the same format
  * as for <code>Properties.load()</code>
  *

libjava/java/util/ResourceBundle.java

@@ -51,7 +51,7 @@ import gnu.classpath.Configuration;
  * <code>getObject</code> or <code>getString</code> on that bundle.
  *
  * <p>When a bundle is demanded for a specific locale, the ResourceBundle
- * is searched in following order (<i>def. language<i> stands for the
+ * is searched in following order (<i>def. language</i> stands for the
  * two letter ISO language code of the default locale (see
  * <code>Locale.getDefault()</code>).
  *
@@ -251,18 +251,22 @@ public abstract class ResourceBundle
    *
    * <p>A sequence of candidate bundle names are generated, and tested in
    * this order, where the suffix 1 means the string from the specified
-   * locale, and the suffix 2 means the string from the default locale:<ul>
+   * locale, and the suffix 2 means the string from the default locale:</p>
+   *
+   * <ul>
    * <li>baseName + "_" + language1 + "_" + country1 + "_" + variant1</li>
    * <li>baseName + "_" + language1 + "_" + country1</li>
    * <li>baseName + "_" + language1</li>
    * <li>baseName + "_" + language2 + "_" + country2 + "_" + variant2</li>
    * <li>baseName + "_" + language2 + "_" + country2</li>
-   * <li>baseName + "_" + language2<li>
+   * <li>baseName + "_" + language2</li>
    * <li>baseName</li>
    * </ul>
    *
    * <p>In the sequence, entries with an empty string are ignored. Next,
-   * <code>getBundle</code> tries to instantiate the resource bundle:<ul>
+   * <code>getBundle</code> tries to instantiate the resource bundle:</p>
+   *
+   * <ul>
    * <li>First, an attempt is made to load a class in the specified classloader
    * which is a subclass of ResourceBundle, and which has a public constructor
    * with no arguments, via reflection.</li>
@@ -277,7 +281,7 @@ public abstract class ResourceBundle
    * in the above sequence are tested in a similar manner, and if any results
    * in a resource bundle, it is assigned as the parent of the first bundle
    * using the <code>setParent</code> method (unless the first bundle already
-   * has a parent).
+   * has a parent).</p>
    *
    * <p>For example, suppose the following class and property files are
    * provided: MyResources.class, MyResources_fr_CH.properties,
@@ -286,10 +290,12 @@ public abstract class ResourceBundle
    * all files are valid (that is, public non-abstract subclasses of
    * ResourceBundle with public nullary constructors for the ".class" files,
    * syntactically correct ".properties" files). The default locale is
-   * Locale("en", "UK").
+   * Locale("en", "UK").</p>
    *
    * <p>Calling getBundle with the shown locale argument values instantiates
-   * resource bundles from the following sources:<ul>
+   * resource bundles from the following sources:</p>
+   *
+   * <ul>
    * <li>Locale("fr", "CH"): result MyResources_fr_CH.class, parent
    *   MyResources_fr.properties, parent MyResources.class</li>
    * <li>Locale("fr", "FR"): result MyResources_fr.properties, parent
@@ -301,8 +307,9 @@ public abstract class ResourceBundle
    * <li>Locale("es", "ES"): result MyResources_es_ES.class, parent
    *   MyResources.class</li>
    * </ul>
-   * The file MyResources_fr_CH.properties is never used because it is hidden
-   * by MyResources_fr_CH.class.
+   * 
+   * <p>The file MyResources_fr_CH.properties is never used because it is hidden
+   * by MyResources_fr_CH.class.</p>
    *
    * @param baseName the name of the ResourceBundle
    * @param locale A locale

libjava/java/util/StringTokenizer.java

@@ -196,7 +196,7 @@ public class StringTokenizer implements Enumeration
 
   /**
    * This does the same as hasMoreTokens. This is the
-   * <code>Enumeration</code interface method.
+   * <code>Enumeration</code> interface method.
    *
    * @return true, if the next call of nextElement() will succeed
    * @see #hasMoreTokens()
@@ -208,7 +208,7 @@ public class StringTokenizer implements Enumeration
 
   /**
    * This does the same as nextTokens. This is the
-   * <code>Enumeration</code interface method.
+   * <code>Enumeration</code> interface method.
    *
    * @return the next token with respect to the current delimiter characters
    * @throws NoSuchElementException if there are no more tokens

libjava/java/util/jar/Attributes.java

@@ -85,17 +85,18 @@ public class Attributes implements Cloneable, Map
    * attributes, applet attributes, extension identification attributes,
    * package versioning and sealing attributes, file contents attributes,
    * bean objects attribute and signing attributes. See the 
-   * <p>
-   * The characters of a Name must obey the following restrictions:
+   * 
+   * <p>The characters of a Name must obey the following restrictions:</p>
+   * 
    * <ul>
-   * <li> Must contain at least one character
-   * <li> The first character must be alphanumeric (a-z, A-Z, 0-9)
-   * <li> All other characters must be alphanumeric, a '-' or a '_'
+   * <li>Must contain at least one character</li>
+   * <li>The first character must be alphanumeric (a-z, A-Z, 0-9)</li>
+   * <li>All other characters must be alphanumeric, a '-' or a '_'</li>
    * </ul>
-   * <p>
-   * When comparing Names (with <code>equals</code>) all characters are
+   * 
+   * <p>When comparing Names (with <code>equals</code>) all characters are
    * converted to lowercase. But you can get the original case sensitive
-   * string with the <code>toString()</code> method.
+   * string with the <code>toString()</code> method.</p>
    *
    * @since 1.2
    * @author Mark Wielaard (mark@klomp.org)
@@ -145,15 +146,15 @@ public class Attributes implements Cloneable, Map
      * Manifest manifest file with the following Names:
      * <ul>
      * <li> &lt;extension&gt;-Extension-Name:
-     * unique name of the extension
+     * unique name of the extension</li>
      * <li> &lt;extension&gt;-Specification-Version:
-     * minimum specification version
+     * minimum specification version</li>
      * <li> &lt;extension&gt;-Implementation-Version:
-     * minimum implementation version
+     * minimum implementation version</li>
      * <li> &lt;extension&gt;-Implementation-Vendor-Id:
-     * unique id of implementation vendor
+     * unique id of implementation vendor</li>
      * <li> &lt;extension&gt;-Implementation-URL:
-     * where the latest version of the extension library can be found
+     * where the latest version of the extension library can be found</li>
      * </ul>
      */
     public static final Name EXTENSION_LIST = new Name("Extension-List");

libjava/java/util/logging/ConsoleHandler.java

@@ -67,7 +67,7 @@ package java.util.logging;
  *
  * <li><code>java.util.logging.ConsoleHandler.encoding</code> - specifies
  *     the name of the character encoding. Default value:
- *     the default platform encoding.
+ *     the default platform encoding.</li>
  *
  * </ul>
  *

libjava/java/util/logging/LogManager.java

@@ -67,13 +67,12 @@ import java.lang.ref.WeakReference;
  * <code>java.util.logging.LogManager</code> is initialized.
  * The configuration process includes the subsequent steps:
  *
- * <ol>
+ * <ul>
  * <li>If the system property <code>java.util.logging.manager</code>
  *     is set to the name of a subclass of
  *     <code>java.util.logging.LogManager</code>, an instance of
  *     that subclass is created and becomes the global LogManager.
  *     Otherwise, a new instance of LogManager is created.</li>
- *     
  * <li>The <code>LogManager</code> constructor tries to create
  *     a new instance of the class specified by the system
  *     property <code>java.util.logging.config.class</code>.
@@ -91,14 +90,13 @@ import java.lang.ref.WeakReference;
  *     {@link #readConfiguration(java.io.InputStream)}.
  *     The name and location of this file are specified by the system
  *     property <code>java.util.logging.config.file</code>.</li>
- *
  * <li>If the system property <code>java.util.logging.config.file</code>
  *     is not set, however, the contents of the URL
  *     "{gnu.classpath.home.url}/logging.properties" are passed to
  *     {@link #readConfiguration(java.io.InputStream)}.
  *     Here, "{gnu.classpath.home.url}" stands for the value of
  *     the system property <code>gnu.classpath.home.url</code>.</li>
- * </ol>
+ * </ul>
  *
  * @author Sascha Brawer (brawer@acm.org)
  */
@@ -259,10 +257,10 @@ public class LogManager
    *
    * @param logger the logger to be added.
    *
-   * @return <code>true<code>if <code>logger</code> was added,
+   * @return <code>true</code>if <code>logger</code> was added,
    *         <code>false</code> otherwise.
    *
-   * @throws NullPointerException if <code>name<code> is
+   * @throws NullPointerException if <code>name</code> is
    *         <code>null</code>.
    */
   public synchronized boolean addLogger(Logger logger)

libjava/java/util/logging/MemoryHandler.java

@@ -35,10 +35,7 @@ module.  An independent module is a module which is not derived from
 or based on this library.  If you modify this library, you may extend
 this exception to your version of the library, but you are not
 obligated to do so.  If you do not wish to do so, delete this
-exception statement from your version.
-
-*/
-
+exception statement from your version. */
 
 package java.util.logging;
 
@@ -53,28 +50,22 @@ package java.util.logging;
  * value, a default is taken without an exception being thrown.
  *
  * <ul>
- *
  * <li><code>java.util.MemoryHandler.level</code> - specifies
  *     the initial severity level threshold. Default value:
  *     <code>Level.ALL</code>.</li>
- *
  * <li><code>java.util.MemoryHandler.filter</code> - specifies
  *     the name of a Filter class. Default value: No Filter.</li>
- *
  * <li><code>java.util.MemoryHandler.size</code> - specifies the
  *     maximum number of log records that are kept in the circular
  *     buffer.  Default value: 1000.</li>
- *
  * <li><code>java.util.MemoryHandler.push</code> - specifies the
  *     <code>pushLevel</code>. Default value:
  *     <code>Level.SEVERE</code>.</li>
- *
  * <li><code>java.util.MemoryHandler.target</code> - specifies the
  *     name of a subclass of {@link Handler} that will be used as the
  *     target handler.  There is no default value for this property;
  *     if it is not set, the no-argument MemoryHandler constructor
  *     will throw an exception.</li>
- *
  * </ul>
  *
  * @author Sascha Brawer (brawer@acm.org)

libjava/java/util/logging/SocketHandler.java

@@ -68,7 +68,7 @@ package java.util.logging;
  *
  * <li><code>java.util.SocketHandler.encoding</code> - specifies
  *     the name of the character encoding. Default value:
- *     the default platform encoding.
+ *     the default platform encoding.</li>
  *
  * <li><code>java.util.SocketHandler.host</code> - specifies
  *     the name of the host to which records are published.