fixed a number of javadoc warnings.

git-svn-id: http://anonsvn.jboss.org/repos/javassist/trunk@64 30ef5769-5b8d-40dd-aea6-55b5d6557bb3

diff --git a/build.xml b/build.xml
index 102f7605f4d0e5aa3316fe152394da532502baa1..fda88d53e421551cb3009cda4320d6c4a815533f 100644 (file)
--- a/build.xml
+++ b/build.xml
@@ -78,6 +78,7 @@ to ${build.classes.dir}.</echo>
            version="true"\r
            use="true"\r
            Locale="en_US"\r
+           charset="iso-8859-1"\r
            Public="true"\r
            nohelp="true"\r
            windowtitle="Javassist API">\r

diff --git a/src/main/javassist/CtClass.java b/src/main/javassist/CtClass.java
index 844c415a5aeeb27dfb35de248ccc294c93fa640a..5d4c82803871134f31f27478803b24370773cd0a 100644 (file)
--- a/src/main/javassist/CtClass.java
+++ b/src/main/javassist/CtClass.java
@@ -321,7 +321,7 @@ public abstract class CtClass {
      * @param oldName           replaced class name
      * @param newName           substituted class name
      */
-    public void replaceClassName(String oldname, String newname) {
+    public void replaceClassName(String oldName, String newName) {
         checkModify();
     }
 
@@ -538,7 +538,6 @@ public abstract class CtClass {
      * For details of the method descriptor, see the JVM specification
      * or <code>javassist.bytecode.Descriptor</code>.
      *
-     * @param name      method name
      * @param desc      method descriptor
      * @see javassist.bytecode.Descriptor
      */

diff --git a/src/main/javassist/CtNewConstructor.java b/src/main/javassist/CtNewConstructor.java
index b9c3114ff9ec4bef4e6fb3322aaeaf67c1877a4b..306a459e8761f715bf4e1715dbd0c9cd9ac8ed7b 100644 (file)
--- a/src/main/javassist/CtNewConstructor.java
+++ b/src/main/javassist/CtNewConstructor.java
@@ -79,8 +79,6 @@ public class CtNewConstructor {
     /**
      * Creates a public constructor.
      *
-     * @param returnType        the type of the returned value.
-     * @param mname             the method name.
      * @param parameters        a list of the parameter types.
      * @param exceptions        a list of the exception types.
      * @param body              the source text of the constructor body.

diff --git a/src/main/javassist/CtNewMethod.java b/src/main/javassist/CtNewMethod.java
index defafcf692e8db7a1786c231ba1a02b3a28d3cee..8bb0d1f9ca2b3af2fcc1b283d041969796cc945b 100644 (file)
--- a/src/main/javassist/CtNewMethod.java
+++ b/src/main/javassist/CtNewMethod.java
@@ -409,8 +409,8 @@ public class CtNewMethod {
      *
      * @param returnType        the type of the returned value.
      * @param mname             the method name.
-     * @param parameters        a list of the parameter types.
-     * @param exceptions        a list of the exception types.
+     * @param parameterTypes    a list of the parameter types.
+     * @param exceptionTypes    a list of the exception types.
      * @param body              the method body
      *                          (must not be a static method).
      * @param constParam        the constant parameter

diff --git a/src/main/javassist/Dump.java b/src/main/javassist/Dump.java
index 1685037979af1eb3b6345f564c80a08722c6c05d..aeb6e45b62b11788ecc17465aff93d367637c12a 100644 (file)
--- a/src/main/javassist/Dump.java
+++ b/src/main/javassist/Dump.java
@@ -36,7 +36,7 @@ public class Dump {
     /**
      * Main method.
      *
-     * @param args[0]           class file name.
+     * @param args           <code>args[0]</code> is the class file name.
      */
     public static void main(String[] args) throws Exception {
         if (args.length != 1) {

diff --git a/src/main/javassist/Loader.java b/src/main/javassist/Loader.java
index 02ccfcfd79d172122c5143035958acbecd8f62fb..f84f7f1cb60c7dec57848a40b02690293e9532f3 100644 (file)
--- a/src/main/javassist/Loader.java
+++ b/src/main/javassist/Loader.java
@@ -207,8 +207,12 @@ public class Loader extends ClassLoader {
      *
      * <p>This method calls <code>run()</code>.
      *
-     * @param args[0]           class name to be loaded.
-     * @param args[1-n]         parameters passed to <code>main()</code>.
+     * @param args              command line parameters.
+     * <ul>
+     * <code>args[0]</code> is the class name to be loaded.
+     * <br><code>args[1..n]</code> are parameters passed
+     *                      to the target <code>main()</code>.
+     * </ul>
      *
      * @see javassist.Loader#run(String[])
      */
@@ -220,8 +224,12 @@ public class Loader extends ClassLoader {
     /**
      * Loads a class and calls <code>main()</code> in that class.
      *
-     * @param args[0]           the name of the loaded class.
-     * @param args[1-n]         parameters passed to <code>main()</code>.
+     * @param args              command line parameters.
+     * <ul>
+     * <code>args[0]</code> is the class name to be loaded.
+     * <br><code>args[1..n]</code> are parameters passed
+     *                      to the target <code>main()</code>.
+     * </ul>
      */
     public void run(String[] args) throws Throwable {
         int n = args.length - 1;

diff --git a/src/main/javassist/bytecode/CodeIterator.java b/src/main/javassist/bytecode/CodeIterator.java
index 5c89bbad54056b510b0cf1985bff3e6b9f85934c..7682dc06b872cac50ebcebca01407869b1154a10 100644 (file)
--- a/src/main/javassist/bytecode/CodeIterator.java
+++ b/src/main/javassist/bytecode/CodeIterator.java
@@ -496,7 +496,7 @@ public class CodeIterator implements Opcode {
     /**
      * Appends a gap at the end of the bytecode sequence.
      *
-     * @param length            gap length
+     * @param gapLength            gap length
      */
     public void appendGap(int gapLength) {
         byte[] code = bytecode;

diff --git a/src/main/javassist/bytecode/ConstPool.java b/src/main/javassist/bytecode/ConstPool.java
index db864243d44e5ff209204e117346cb7b36c7184d..79626cfd43ebfc947338b61f697f8b5b8a409dfa 100644 (file)
--- a/src/main/javassist/bytecode/ConstPool.java
+++ b/src/main/javassist/bytecode/ConstPool.java
@@ -684,7 +684,7 @@ public final class ConstPool {
      * Adds a new <code>CONSTANT_Fieldref_info</code> structure.
      *
      * @param classInfo         <code>class_index</code>
-     * @param nameandtypeinfo   <code>name_and_type_index</code>.
+     * @param nameAndTypeInfo   <code>name_and_type_index</code>.
      * @return          the index of the added entry.
      */
     public int addFieldrefInfo(int classInfo, int nameAndTypeInfo) {
@@ -713,7 +713,7 @@ public final class ConstPool {
      * Adds a new <code>CONSTANT_Methodref_info</code> structure.
      *
      * @param classInfo         <code>class_index</code>
-     * @param nameandtypeinfo   <code>name_and_type_index</code>.
+     * @param nameAndTypeInfo   <code>name_and_type_index</code>.
      * @return          the index of the added entry.
      */
     public int addMethodrefInfo(int classInfo, int nameAndTypeInfo) {
@@ -745,7 +745,7 @@ public final class ConstPool {
      * structure.
      *
      * @param classInfo         <code>class_index</code>
-     * @param nameandtypeinfo   <code>name_and_type_index</code>.
+     * @param nameAndTypeInfo   <code>name_and_type_index</code>.
      * @return          the index of the added entry.
      */
     public int addInterfaceMethodrefInfo(int classInfo,

diff --git a/src/main/javassist/bytecode/DeprecatedAttribute.java b/src/main/javassist/bytecode/DeprecatedAttribute.java
index 40696d35770392ed4950f8d0bcf21f22934d2d80..42a67bd3c8088d8a6a0a8a4091851839f89c673a 100644 (file)
--- a/src/main/javassist/bytecode/DeprecatedAttribute.java
+++ b/src/main/javassist/bytecode/DeprecatedAttribute.java
@@ -38,7 +38,6 @@ public class DeprecatedAttribute extends AttributeInfo {
      * Constructs a Deprecated attribute.
      *
      * @param cp                a constant pool table.
-     * @param filename          the name of the source file.
      */
     public DeprecatedAttribute(ConstPool cp) {
         super(cp, tag, new byte[0]);

diff --git a/src/main/javassist/bytecode/SyntheticAttribute.java b/src/main/javassist/bytecode/SyntheticAttribute.java
index e551c0a789ff662c14b1180a7347f802efd25159..45b3b3e82d0a041745bf0b39e52d632ba8a40263 100644 (file)
--- a/src/main/javassist/bytecode/SyntheticAttribute.java
+++ b/src/main/javassist/bytecode/SyntheticAttribute.java
@@ -38,7 +38,6 @@ public class SyntheticAttribute extends AttributeInfo {
      * Constructs a Synthetic attribute.
      *
      * @param cp                a constant pool table.
-     * @param filename          the name of the source file.
      */
     public SyntheticAttribute(ConstPool cp) {
         super(cp, tag, new byte[0]);

diff --git a/src/main/javassist/reflect/Loader.java b/src/main/javassist/reflect/Loader.java
index fa0aac6d1b0250d687b85c50dc815e63c274de05..620bc346ce8611518c323fa92793fd0a27f13852 100644 (file)
--- a/src/main/javassist/reflect/Loader.java
+++ b/src/main/javassist/reflect/Loader.java
@@ -64,7 +64,7 @@ import javassist.ClassPool;
  *
  * <p>This program is run as follows:
  *
- * <ul><pre>% java Main2 arg1, ...</code>
+ * <ul><pre>% java Main2 arg1, ...</pre></ul>
  *
  * <p>The difference from the former one is that the class <code>Main</code>
  * is loaded by <code>javassist.reflect.Loader</code> whereas the class
@@ -113,8 +113,12 @@ public class Loader extends javassist.Loader {
      * Loads a class with an instance of <code>Loader</code>
      * and calls <code>main()</code> in that class.
      *
-     * @param args[0]           class name to be loaded.
-     * @param args[1-n]         parameters passed to <code>main()</code>.
+     * @param args              command line parameters.
+     * <ul>
+     * <code>args[0]</code> is the class name to be loaded.
+     * <br><code>args[1..n]</code> are parameters passed
+     *                      to the target <code>main()</code>.
+     * </ul>
      */
     public static void main(String[] args) throws Throwable {
         Loader cl = new Loader();

diff --git a/src/main/javassist/rmi/AppletServer.java b/src/main/javassist/rmi/AppletServer.java
index 29325c5b3b19c7c438d28e0d1c7775da26ab4d63..4ac9887ddbd2cf5006f3e10198bd8c480848b752 100644 (file)
--- a/src/main/javassist/rmi/AppletServer.java
+++ b/src/main/javassist/rmi/AppletServer.java
@@ -99,7 +99,7 @@ public class AppletServer extends Webserver {
      * the proxy class and call a method on the exported object.
      *
      * @param name      the name used for looking the object up.
-     * @param object    the exported object.
+     * @param obj       the exported object.
      * @return          the object identifier
      *
      * @see javassist.rmi.ObjectImporter#lookupObject(String)