[jboss-cvs] JBossAS SVN: r102221 - in projects/jboss-reflect/trunk/src/main/java/org/jboss: reflect/plugins/javassist/classpool and 2 other directories.

jboss-cvs-commits at lists.jboss.org jboss-cvs-commits at lists.jboss.org
Wed Mar 10 07:18:33 EST 2010


Author: flavia.rainone at jboss.com
Date: 2010-03-10 07:18:32 -0500 (Wed, 10 Mar 2010)
New Revision: 102221

Modified:
   projects/jboss-reflect/trunk/src/main/java/org/jboss/beans/info/plugins/AbstractBeanInfo.java
   projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/classpool/RepositoryClassPoolFactory.java
   projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Cast.java
   projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/ConstructorCall.java
   projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Expression.java
   projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/FieldAccess.java
   projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Handler.java
   projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Instanceof.java
   projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/MethodCall.java
   projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/NewArray.java
   projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/NewExpression.java
   projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/spi/MutableClassInfo.java
   projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/spi/MutableTypeInfoFactory.java
   projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/spi/NotFoundException.java
Log:
[JBREFLECT-104] Cleaned all javadoc warnings from jboss-reflect project

Modified: projects/jboss-reflect/trunk/src/main/java/org/jboss/beans/info/plugins/AbstractBeanInfo.java
===================================================================
--- projects/jboss-reflect/trunk/src/main/java/org/jboss/beans/info/plugins/AbstractBeanInfo.java	2010-03-10 12:08:35 UTC (rev 102220)
+++ projects/jboss-reflect/trunk/src/main/java/org/jboss/beans/info/plugins/AbstractBeanInfo.java	2010-03-10 12:18:32 UTC (rev 102221)
@@ -1,24 +1,24 @@
 /*
-* JBoss, Home of Professional Open Source
-* Copyright 2005, JBoss Inc., and individual contributors as indicated
-* by the @authors tag. See the copyright.txt in the distribution for a
-* full listing of individual contributors.
-*
-* This is free software; you can redistribute it and/or modify it
-* under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation; either version 2.1 of
-* the License, or (at your option) any later version.
-*
-* This software 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
-* Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public
-* License along with this software; if not, write to the Free
-* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-*/
+ * JBoss, Home of Professional Open Source
+ * Copyright 2005, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
 package org.jboss.beans.info.plugins;
 
 import java.util.Arrays;
@@ -149,10 +149,10 @@
    }
 
    /**
-    * Find property
+    * Finds a property.
     *
-    * @param name the property name
-    * @return the property or null if no such property
+    * @param propertyName the name of the property
+    * @return the requested property or {@code null} if no such property is found
     */
    protected PropertyInfo findPropertyInfo(String propertyName)
    {

Modified: projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/classpool/RepositoryClassPoolFactory.java
===================================================================
--- projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/classpool/RepositoryClassPoolFactory.java	2010-03-10 12:08:35 UTC (rev 102220)
+++ projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/classpool/RepositoryClassPoolFactory.java	2010-03-10 12:18:32 UTC (rev 102221)
@@ -32,7 +32,7 @@
  * corresponding ClassLoader with
  * {@link ScopedClassPoolRepository#registerClassLoader(ClassLoader)}.
  * For that reason, it is important to register a ScopedClassPoolFactory
- * ({@link ScopedClassPoolRepository#setClassPoolFactory(org.jboss.classpool.scoped.ScopedClassPoolFactory))
+ * ({@link ScopedClassPoolRepository#setClassPoolFactory(org.jboss.classpool.scoped.ScopedClassPoolFactory)}))
  * prior to using this factory.
  * 
  * @author <a href="mailto:flavia.rainone at jboss.org">Flavia Rainone</a>

Modified: projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Cast.java
===================================================================
--- projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Cast.java	2010-03-10 12:08:35 UTC (rev 102220)
+++ projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Cast.java	2010-03-10 12:18:32 UTC (rev 102221)
@@ -1,3 +1,24 @@
+/*
+ * JBoss, Home of Professional Open Source
+ * Copyright 2006, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
 package org.jboss.reflect.plugins.javassist.expr;
 
 import org.jboss.reflect.spi.CannotCompileException;
@@ -8,11 +29,10 @@
 {
    
    /**
-    * Returns the <code>CtClass</code> object representing
-    * the type specified by the cast.
+    * Returns the class representing the type specified by the cast.
     * 
-    * @return
-    * @throws NotFoundException
+    * @return                    the mutable class info representing this cast
+    * @throws NotFoundException  if the requested class info cannot be found 
     */
    public MutableClassInfo getType() throws NotFoundException;
 

Modified: projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/ConstructorCall.java
===================================================================
--- projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/ConstructorCall.java	2010-03-10 12:08:35 UTC (rev 102220)
+++ projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/ConstructorCall.java	2010-03-10 12:18:32 UTC (rev 102221)
@@ -1,3 +1,24 @@
+/*
+ * JBoss, Home of Professional Open Source
+ * Copyright 2006, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
 package org.jboss.reflect.plugins.javassist.expr;
 
 import org.jboss.reflect.spi.MutableConstructorInfo;
@@ -3,4 +24,10 @@
 import org.jboss.reflect.spi.NotFoundException;
 
+/**
+ * An Expression.
+ * 
+ * @author <a href="mailto:stale.pedersen at jboss.org">Stale W. Pedersen</a>
+ * @version $Revision: 1.1 $
+ */
 public interface ConstructorCall extends MethodCall
 {
@@ -9,8 +36,8 @@
    /**
     * Returns the called constructor.
     * 
-    * @return
+    * @return the called constructor
     * @throws NotFoundException
     */
    public MutableConstructorInfo getConstructor() throws NotFoundException;
-}
+}
\ No newline at end of file

Modified: projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Expression.java
===================================================================
--- projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Expression.java	2010-03-10 12:08:35 UTC (rev 102220)
+++ projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Expression.java	2010-03-10 12:18:32 UTC (rev 102221)
@@ -1,24 +1,24 @@
 /*
-* JBoss, Home of Professional Open Source
-* Copyright 2006, JBoss Inc., and individual contributors as indicated
-* by the @authors tag. See the copyright.txt in the distribution for a
-* full listing of individual contributors.
-*
-* This is free software; you can redistribute it and/or modify it
-* under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation; either version 2.1 of
-* the License, or (at your option) any later version.
-*
-* This software 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
-* Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public
-* License along with this software; if not, write to the Free
-* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-*/
+ * JBoss, Home of Professional Open Source
+ * Copyright 2006, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
 package org.jboss.reflect.plugins.javassist.expr;
 
 import org.jboss.reflect.spi.CannotCompileException;
@@ -27,7 +27,7 @@
 import org.jboss.reflect.spi.MutableMethodInfo;
 
 /**
- * A Expression.
+ * An Expression.
  * 
  * @author <a href="mailto:stale.pedersen at jboss.org">Stale W. Pedersen</a>
  * @version $Revision: 1.1 $
@@ -35,47 +35,44 @@
 public interface Expression
 {
    /**
-    * Returns the method containing the <tt>new</tt>
-    * expression represented by this object.
+    * Returns the method containing the expression represented by this object.
     * 
-    * @return
+    * @return the method that contains this expression
     */
    public MutableMethodInfo whereMethod();
    
    /**
-    * Returns the constructor containing the <tt>new</tt>
-    * expression represented by this object.
+    * Returns the constructor containing the expression represented by this object.
     * 
-    * @return
+    * @return the constructors that contains this expression
     */
    public MutableConstructorInfo whereConstructor();
 
    /**
-    * FIXME Comment this
+    * Returns a list of the exception types that this expression execution may throw.
     * 
-    * @return
+    * @return a list of the exceptions that this expression may throw
     */
    public MutableClassInfo[] mayThrow();
    
    /**
     * FIXME Comment this
     * 
-    * @return
+    * @return the index of bytecode
     */
    public int indexOfBytecode();
    
    /**
-    * Returns the line number of the source line containing the
-     * <tt>new</tt> expression.
+    * Returns the line number of the source file containing this expression.
     * 
-    * @return
+    * @return the line number of this expression
     */
    public int getLineNumber();
    
    /**
-    * Returns the source file containing the <tt>new</tt> expression.
+    * Returns the name of source file that contains this expression.
     * 
-    * @return
+    * @return the name of the file containing this expression
     */
    public String getFileName();
    

Modified: projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/FieldAccess.java
===================================================================
--- projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/FieldAccess.java	2010-03-10 12:08:35 UTC (rev 102220)
+++ projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/FieldAccess.java	2010-03-10 12:18:32 UTC (rev 102221)
@@ -1,24 +1,24 @@
 /*
-* JBoss, Home of Professional Open Source
-* Copyright 2006, JBoss Inc., and individual contributors as indicated
-* by the @authors tag. See the copyright.txt in the distribution for a
-* full listing of individual contributors.
-*
-* This is free software; you can redistribute it and/or modify it
-* under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation; either version 2.1 of
-* the License, or (at your option) any later version.
-*
-* This software 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
-* Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public
-* License along with this software; if not, write to the Free
-* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-*/
+ * JBoss, Home of Professional Open Source
+ * Copyright 2006, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
 package org.jboss.reflect.plugins.javassist.expr;
 
 import org.jboss.reflect.spi.CannotCompileException;
@@ -35,44 +35,44 @@
 {
 
    /**
-    * Returns true if the field is static.
+    * Indicates whether the field is static.
     * 
-    * @return
+    * @return {@code} if the field being accessed is static
     */
    public boolean isStatic();
    
    /**
-    * Returns true if the field is read.
+    * Returns {@code true} if the field is being read.
     * 
-    * @return
+    * @return {@code true} if this expression reads the value of a field
     */
    public boolean isReader();
    
    /**
-    * Returns true if the field is written in.
+    * Returns true if the field is  being written in.
     * 
-    * @return
+    * @return {@code true} if this expression writes the value of a field
     */
    public boolean isWriter();
    
    /**
     * Returns the name of the class in which the field is declared.
     * 
-    * @return
+    * @return  the name of the class declaring the field
     */
    public String getClassName();
    
    /**
     * Returns the name of the field.
     * 
-    * @return
+    * @return the name of the field
     */
    public String getFieldName();
    
    /**
     * Returns the field accessed by this expression.
     * 
-    * @return
+    * @return the field accessed by this expression
     * @throws NotFoundException
     */
    public MutableFieldInfo getField() throws NotFoundException;
@@ -82,7 +82,7 @@
     * The signature is represented by a character string
     * called field descriptor, which is defined in the JVM specification.
     * 
-    * @return
+    * @return the signature of the field being accessed
     */
    public String getSignature();
    

Modified: projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Handler.java
===================================================================
--- projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Handler.java	2010-03-10 12:08:35 UTC (rev 102220)
+++ projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Handler.java	2010-03-10 12:18:32 UTC (rev 102221)
@@ -1,24 +1,24 @@
 /*
-* JBoss, Home of Professional Open Source
-* Copyright 2006, JBoss Inc., and individual contributors as indicated
-* by the @authors tag. See the copyright.txt in the distribution for a
-* full listing of individual contributors.
-*
-* This is free software; you can redistribute it and/or modify it
-* under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation; either version 2.1 of
-* the License, or (at your option) any later version.
-*
-* This software 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
-* Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public
-* License along with this software; if not, write to the Free
-* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-*/
+ * JBoss, Home of Professional Open Source
+ * Copyright 2006, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
 package org.jboss.reflect.plugins.javassist.expr;
 
 import org.jboss.reflect.spi.CannotCompileException;
@@ -26,7 +26,7 @@
 import org.jboss.reflect.spi.NotFoundException;
 
 /**
- * A Handler.
+ * An exception handler.
  * 
  * @author <a href="mailto:stale.pedersen at jboss.org">Stale W. Pedersen</a>
  * @version $Revision: 1.1 $
@@ -37,7 +37,7 @@
    /**
     * Returns the type handled by the catch clause.
     * 
-    * @return
+    * @return the type of the exception being handled by this expression
     * @throws NotFoundException
     */
    public MutableClassInfo getType() throws NotFoundException;

Modified: projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Instanceof.java
===================================================================
--- projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Instanceof.java	2010-03-10 12:08:35 UTC (rev 102220)
+++ projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/Instanceof.java	2010-03-10 12:18:32 UTC (rev 102221)
@@ -1,31 +1,31 @@
 /*
-* JBoss, Home of Professional Open Source
-* Copyright 2006, JBoss Inc., and individual contributors as indicated
-* by the @authors tag. See the copyright.txt in the distribution for a
-* full listing of individual contributors.
-*
-* This is free software; you can redistribute it and/or modify it
-* under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation; either version 2.1 of
-* the License, or (at your option) any later version.
-*
-* This software 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
-* Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public
-* License along with this software; if not, write to the Free
-* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-*/
+ * JBoss, Home of Professional Open Source
+ * Copyright 2006, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
 package org.jboss.reflect.plugins.javassist.expr;
 
 import org.jboss.reflect.spi.MutableClassInfo;
 import org.jboss.reflect.spi.NotFoundException;
 
 /**
- * A Instanceof.
+ * An {@code instanceof} expression
  * 
  * @author <a href="mailto:stale.pedersen at jboss.org">Stale W. Pedersen</a>
  * @version $Revision: 1.1 $
@@ -38,7 +38,7 @@
     * the type name on the right hand side
     * of the instanceof operator.
     * 
-    * @return
+    * @return the type that is being tested by this {@code instanceof} expression
     * @throws NotFoundException
     */
    public MutableClassInfo getType() throws NotFoundException;

Modified: projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/MethodCall.java
===================================================================
--- projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/MethodCall.java	2010-03-10 12:08:35 UTC (rev 102220)
+++ projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/MethodCall.java	2010-03-10 12:18:32 UTC (rev 102221)
@@ -1,24 +1,24 @@
 /*
-* JBoss, Home of Professional Open Source
-* Copyright 2006, JBoss Inc., and individual contributors as indicated
-* by the @authors tag. See the copyright.txt in the distribution for a
-* full listing of individual contributors.
-*
-* This is free software; you can redistribute it and/or modify it
-* under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation; either version 2.1 of
-* the License, or (at your option) any later version.
-*
-* This software 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
-* Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public
-* License along with this software; if not, write to the Free
-* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-*/
+ * JBoss, Home of Professional Open Source
+ * Copyright 2006, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
 package org.jboss.reflect.plugins.javassist.expr;
 
 import org.jboss.reflect.spi.CannotCompileException;
@@ -26,7 +26,7 @@
 import org.jboss.reflect.spi.NotFoundException;
 
 /**
- * A MethodCall.
+ * A method call expression.
  * 
  * @author <a href="mailto:stale.pedersen at jboss.org">Stale W. Pedersen</a>
  * @version $Revision: 1.1 $
@@ -38,39 +38,40 @@
     * Returns the class name of the target object,
      * which the method is called on.
     * 
-    * @return
+    * @return the name of the target class
     */
    public String getClassName();
    
    /**
-    * Returns the name of the called method. 
+    * Returns the name of the called method.
     * 
-    * @return
+    * @return the name of the method being called
     */
    public String getMethodName();
    
    /**
-    * Get the called method
+    * Returns the called method.
     * 
-    * @return
+    * @return the method being called
     * @throws NotFoundException
     */
    public MutableMethodInfo getMethod() throws NotFoundException;
    
    
    /**
-    * Return the method signature
+    * Returns the method signature.
     * 
-    * @return
+    * @return the signature of the method being called
     */
    public String getSignatue();
    
    /**
-    * Returns true if the called method is of a superclass of the current
+    * Indicates whether the called method is of a superclass of the current
      * class.
     * 
-    * @return
+    * @return returns {@code true} if the target class is a super class of the current class
     */
+   // TODO improve this doc JBREFLECT-78
    public boolean isSuper();
    
    /**

Modified: projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/NewArray.java
===================================================================
--- projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/NewArray.java	2010-03-10 12:08:35 UTC (rev 102220)
+++ projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/NewArray.java	2010-03-10 12:18:32 UTC (rev 102221)
@@ -1,24 +1,24 @@
 /*
-* JBoss, Home of Professional Open Source
-* Copyright 2006, JBoss Inc., and individual contributors as indicated
-* by the @authors tag. See the copyright.txt in the distribution for a
-* full listing of individual contributors.
-*
-* This is free software; you can redistribute it and/or modify it
-* under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation; either version 2.1 of
-* the License, or (at your option) any later version.
-*
-* This software 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
-* Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public
-* License along with this software; if not, write to the Free
-* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-*/
+ * JBoss, Home of Professional Open Source
+ * Copyright 2006, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
 package org.jboss.reflect.plugins.javassist.expr;
 
 import org.jboss.reflect.spi.CannotCompileException;
@@ -26,7 +26,7 @@
 import org.jboss.reflect.spi.NotFoundException;
 
 /**
- * A NewArray.
+ * A new array expression.
  * 
  * @author <a href="mailto:stale.pedersen at jboss.org">Stale W. Pedersen</a>
  * @version $Revision: 1.1 $
@@ -36,21 +36,20 @@
 
    /**
     * Returns the type of array components.  If the created array is
-    * a two-dimensional array of <tt>int</tt>,
-    * the type returned by this method is
-    * not <tt>int[]</tt> but <tt>int</tt>.
+    * a two-dimensional array of {@code int}, the type returned by this method is
+    * not {@code int[]} but {@code int}.
     * 
-    * @return
+    * @return  the type of array components
     * @throws NotFoundException
     */
    public MutableClassInfo getComponentType() throws NotFoundException;
    
    /**
-    * Returns the number of dimensions of arrays to be created.
+    * Returns the number of dimensions of the array being created.
      * If the opcode is multianewarray, this method returns the second
      * operand.  Otherwise, it returns 1.
     * 
-    * @return
+    * @return the number of dimensions of the array being created
     */
    public int getCreatedDimensions();
    

Modified: projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/NewExpression.java
===================================================================
--- projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/NewExpression.java	2010-03-10 12:08:35 UTC (rev 102220)
+++ projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/plugins/javassist/expr/NewExpression.java	2010-03-10 12:18:32 UTC (rev 102221)
@@ -1,24 +1,24 @@
 /*
-* JBoss, Home of Professional Open Source
-* Copyright 2006, JBoss Inc., and individual contributors as indicated
-* by the @authors tag. See the copyright.txt in the distribution for a
-* full listing of individual contributors.
-*
-* This is free software; you can redistribute it and/or modify it
-* under the terms of the GNU Lesser General Public License as
-* published by the Free Software Foundation; either version 2.1 of
-* the License, or (at your option) any later version.
-*
-* This software 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
-* Lesser General Public License for more details.
-*
-* You should have received a copy of the GNU Lesser General Public
-* License along with this software; if not, write to the Free
-* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-*/
+ * JBoss, Home of Professional Open Source
+ * Copyright 2006, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
 package org.jboss.reflect.plugins.javassist.expr;
 
 import org.jboss.reflect.spi.CannotCompileException;
@@ -31,21 +31,21 @@
    /**
     * Returns the class name of the created object.
     * 
-    * @return
+    * @return the name of the target class
     */
    public String getClassName();
    
    /**
-    * Get the signature of the constructor
+    * Returns the signature of the constructor.
     * 
-    * @return
+    * @return the signature of the constructor being called
     */
    public String getSignature();
    
    /**
     * Returns the constructor called for creating the object.
     * 
-    * @return
+    * @return the constructor that is called by this expression
     * @throws NotFoundException
     */
    public MutableConstructorInfo getConstructor() throws NotFoundException;

Modified: projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/spi/MutableClassInfo.java
===================================================================
--- projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/spi/MutableClassInfo.java	2010-03-10 12:08:35 UTC (rev 102220)
+++ projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/spi/MutableClassInfo.java	2010-03-10 12:18:32 UTC (rev 102221)
@@ -1,24 +1,24 @@
 /*
-  * JBoss, Home of Professional Open Source
-  * Copyright 2005, JBoss Inc., and individual contributors as indicated
-  * by the @authors tag. See the copyright.txt in the distribution for a
-  * full listing of individual contributors.
-  *
-  * This is free software; you can redistribute it and/or modify it
-  * under the terms of the GNU Lesser General Public License as
-  * published by the Free Software Foundation; either version 2.1 of
-  * the License, or (at your option) any later version.
-  *
-  * This software 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
-  * Lesser General Public License for more details.
-  *
-  * You should have received a copy of the GNU Lesser General Public
-  * License along with this software; if not, write to the Free
-  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-  */
+ * JBoss, Home of Professional Open Source
+ * Copyright 2005, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
 package org.jboss.reflect.spi;
 
 /**
@@ -117,65 +117,65 @@
     * Compiles the code included in Body and returns a MutableMethodInfo representation of it.
     * The Body must include the whole declaration of the method.
     * 
-    * @param body
-    * @return
+    * @param body  contains the entire declaration of the method, including its signature
+    * @return      the created method
     */
    MutableMethodInfo createMutableMethod(Body body);
    
    /**
-    * Compiles an empty method with the signature given by the params.
+    * Compiles an empty method with the signature given by the parameters.
     * 
-    * @param modifiers
-    * @param returnType
-    * @param name
-    * @param parameters
-    * @param exceptions
-    * @return
+    * @param modifiers   the modifiers of the method to be created
+    * @param returnType  the return type of the method to be created
+    * @param name        the name of the method to be created
+    * @param parameters  the parameters of the method to be created
+    * @param exceptions  the exceptions that the method to be created declares to throw
+    * @return            the created method
     */
    MutableMethodInfo createMutableMethod(int modifiers, String returnType, 
          String name, String[] parameters, String[] exceptions);
    
    /**
-    * Compiles an empty method with the signature given by the params.
+    * Compiles an empty method with the signature given by the parameters.
     * 
-    * @param modifiers
-    * @param returnType
-    * @param name
-    * @param parameters
-    * @param exceptions
-    * @return
+    * @param modifiers   the modifiers of the method to be created
+    * @param returnType  the return type of the method to be created
+    * @param name        the name of the method to be created
+    * @param parameters  the parameters of the method to be created
+    * @param exceptions  the exceptions that the method to be created declares to throw
+    * @return            the created method
     */
    MutableMethodInfo createMutableMethod(int modifiers, ClassInfo returnType, 
          String name, ClassInfo[] parameters, ClassInfo[] exceptions);
    
    
    /**
-    * Compile a method with the signature and body given by the params.
+    * Compiles a method with the signature and body given by the parameters.
     * Note that the source code of the body must be surrounded by <code>{}</code>.
     * 
-    * @param modifiers
-    * @param returnType
-    * @param name
-    * @param body
-    * @param parameters
-    * @param exceptions
-    * @return
+    * @param modifiers   the modifiers of the method to be created
+    * @param returnType  the return type of the method to be created
+    * @param name        the name of the method to be created
+    * @param body        the body of the method to be created
+    * @param parameters  the parameters of the method to be created
+    * @param exceptions  the exceptions that the method to be created declares to throw
+    * @return            the created method
     */
    MutableMethodInfo createMutableMethod(int modifiers, String returnType, String name, 
          Body body, String[] parameters, String[] exceptions);
 
  
    /**
-    * Compile a method with the signature and body given by the params.
+    * Compiles a method with the signature and body given by the parameters.
     * Note that the source code of the body must be surrounded by <code>{}</code>.
     * 
-    * @param modifiers
-    * @param returnType
-    * @param name
-    * @param body
-    * @param parameters
-    * @param exceptions
-    * @return
+    * @param modifiers   the modifiers of the method to be created
+    * @param returnType  the return type of the method to be created
+    * @param name        the name of the method to be created
+    * @param body        the body of the method to be created
+    * @param parameters  the parameters of the method to be created
+    * @param exceptions  the exceptions that the method to be created declares to throw
+    * @return            the created method
     */
    MutableMethodInfo createMutableMethod(int modifiers, ClassInfo returnType, String name,
          Body body, ClassInfo[] parameters, ClassInfo[] exceptions);
@@ -186,76 +186,76 @@
     * representation of it. The Body must include the whole declaration.
     * The 
     * 
-    * @param body
-    * @return
+    * @param body contains the code of the constructor to be created
+    * @return     the created constructor
     */
    MutableConstructorInfo createMutableConstructor(Body body);
    
    /**
-    * Creates an emptry constructor with params given.
+    * Creates an empty constructor with parameters given.
     * 
-    * @param modifiers
-    * @param parameters
-    * @param exceptions
-    * @return
+    * @param modifiers   the modifiers of the constructor to be created
+    * @param parameters  the parameters of the constructor to be created
+    * @param exceptions  the exceptions that the constructor to be created declares to throw
+    * @return            the created constructor
     */
    MutableConstructorInfo createMutableConstructor(int modifiers, String[] parameters, 
          String[] exceptions);
    
    /**
-    * Creates an emptry constructor with params given.
+    * Creates an empty constructor with the parameters given.
     * 
-    * @param modifiers
-    * @param parameters
-    * @param exceptions
-    * @return
+    * @param modifiers   the modifiers of the constructor to be created
+    * @param parameters  the parameters of the constructor to be created
+    * @param exceptions  the exceptions that the constructor to be created declares to throw
+    * @return            the created constructor
     */
    MutableConstructorInfo createMutableConstructor(int modifiers, ClassInfo[] parameters, 
          ClassInfo[] exceptions);
    
    /**
-    * Create a constructor with the params given.
+    * Creates a constructor with the parameters given.
     * Note that the source text of the Body must be surrounded by <code>{}</code>.
     * 
-    * @param modifiers
-    * @param body
-    * @param parameters
-    * @param exceptions
-    * @return
+    * @param modifiers   the modifiers of the constructor to be created
+    * @param body        the body of the constructor to be created
+    * @param parameters  the parameters of the constructor to be created
+    * @param exceptions  the exceptions that the constructor to be created declares to throw
+    * @return            the created constructor
     */
    MutableConstructorInfo createMutableConstructor(int modifiers, Body body,
          String[] parameters, String[] exceptions);
    
    /**
-    * Create a constructor with the params given.
+    * Creates a constructor with the parameters given.
     * Note that the source text of the Body must be surrounded by <code>{}</code>.
     * 
-    * @param modifiers
-    * @param body
-    * @param parameters
-    * @param exceptions
-    * @return
+    * @param modifiers   the modifiers of the constructor to be created
+    * @param body        the body of the constructor to be created
+    * @param parameters  the parameters of the constructor to be created
+    * @param exceptions  the exceptions that the constructor to be created declares to throw
+    * @return            the created constructor
     */
    MutableConstructorInfo createMutableConstructor(int modifiers, Body body,
          ClassInfo[] parameters, ClassInfo[] exceptions);
    
    /**
-    * Create a field connected to this class with the params given.
+    * Creates a field connected to this class with the parameters given.
     * 
-    * @param modifiers
-    * @param type
-    * @param name
-    * @return
+    * @param modifiers  the modifiers of the field to be created
+    * @param type       the type of the field to be created
+    * @param name       the name of the field to be created
+    * @return           the created field
     */
    MutableFieldInfo createMutableField(int modifiers, String type, String name);
    
    /**
-    * Create a field connected to this class with the params given.
+    * Creates a field connected to this class with the parameters given.
     * 
-    * @param modifiers
-    * @param type
-    * @param name
-    * @return
+    * @param modifiers  the modifiers of the field to be created
+    * @param type       the type of the field to be created
+    * @param name       the name of the field to be created
+    * @return           the created field
     */
    MutableFieldInfo createMutableField(int modifiers, ClassInfo type, String name);
    
@@ -303,9 +303,9 @@
    
    /**
     * Converts the class to a Class file. 
-    * After this method is called, no modifications to the class is allowed.
+    * After this method is called, no modifications to the class are allowed.
     * 
-    * @return
+    * @return this class in bytecodes
     */
    byte[] toByteCode();
    

Modified: projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/spi/MutableTypeInfoFactory.java
===================================================================
--- projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/spi/MutableTypeInfoFactory.java	2010-03-10 12:08:35 UTC (rev 102220)
+++ projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/spi/MutableTypeInfoFactory.java	2010-03-10 12:18:32 UTC (rev 102221)
@@ -1,24 +1,24 @@
 /*
-  * JBoss, Home of Professional Open Source
-  * Copyright 2005, JBoss Inc., and individual contributors as indicated
-  * by the @authors tag. See the copyright.txt in the distribution for a
-  * full listing of individual contributors.
-  *
-  * This is free software; you can redistribute it and/or modify it
-  * under the terms of the GNU Lesser General Public License as
-  * published by the Free Software Foundation; either version 2.1 of
-  * the License, or (at your option) any later version.
-  *
-  * This software 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
-  * Lesser General Public License for more details.
-  *
-  * You should have received a copy of the GNU Lesser General Public
-  * License along with this software; if not, write to the Free
-  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-  */
+ * JBoss, Home of Professional Open Source
+ * Copyright 2005, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
 package org.jboss.reflect.spi;
 
 /**
@@ -31,46 +31,47 @@
 {
 
    /**
-    * Create a new MutableClass
+    * Creates a new MutableClass.
     * 
-    * @param name
-    * @return
+    * @param name the name of the class to be created
+    * @return     the created class
     */
    MutableClassInfo createNewMutableClass(String name);
    
    /**
-    * Create a new MutableClass
+    * Creates a new MutableClass.
     * 
-    * @param name
-    * @param superClass
-    * @return
+    * @param name       the name of the class to be created
+    * @param superClass the super class of the class to be created
+    * @return           the created class
     */
    MutableClassInfo createNewMutableClass(String name, ClassInfo superClass);
    
    /**
-    * Create a new mutable interface
+    * Creates a new mutable interface.
     * 
-    * @param name
-    * @return
+    * @param name  the name of the interface to be created
+    * @return      the created interface
     */
    MutableClassInfo createNewMutableInterface(String name);
    
    /**
-    * Create a new mutable interface
+    * Creates a new mutable interface.
     * 
-    * @param name
-    * @param superClass
-    * @return
+    * @param name       the name of the interface to be created
+    * @param superClass the super type of the interface to be created
+    * @return           the created interface
     */
    MutableClassInfo createNewMutableInterface(String name, ClassInfo superClass);
    
    /**
-    * Get the information for a MutableClass.
-    * Note that this will not put the MutableClass in any cache
+    * Gets the information for a MutableClass.
+    * Note that this will not put the MutableClass in any cache.
     * 
-    * @param name
-    * @param cl - if cl is null, the default ClassLoader will be used.
-    * @return
+    * @param name the name of the class to be retrieved
+    * @param cl   the ClassLoader that should be used to retrieve the class. Note that,
+    *             if cl is null, the default ClassLoader will be used.
+    * @return     the MutableClassInfo representation of the queried class
     */
    MutableClassInfo getMutable(String name, ClassLoader cl);
    

Modified: projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/spi/NotFoundException.java
===================================================================
--- projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/spi/NotFoundException.java	2010-03-10 12:08:35 UTC (rev 102220)
+++ projects/jboss-reflect/trunk/src/main/java/org/jboss/reflect/spi/NotFoundException.java	2010-03-10 12:18:32 UTC (rev 102221)
@@ -1,24 +1,24 @@
 /*
-  * JBoss, Home of Professional Open Source
-  * Copyright 2005, JBoss Inc., and individual contributors as indicated
-  * by the @authors tag. See the copyright.txt in the distribution for a
-  * full listing of individual contributors.
-  *
-  * This is free software; you can redistribute it and/or modify it
-  * under the terms of the GNU Lesser General Public License as
-  * published by the Free Software Foundation; either version 2.1 of
-  * the License, or (at your option) any later version.
-  *
-  * This software 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
-  * Lesser General Public License for more details.
-  *
-  * You should have received a copy of the GNU Lesser General Public
-  * License along with this software; if not, write to the Free
-  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-  */
+ * JBoss, Home of Professional Open Source
+ * Copyright 2005, JBoss Inc., and individual contributors as indicated
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
 package org.jboss.reflect.spi;
 
 /**
@@ -31,13 +31,13 @@
 {
 
    /**
-    * Create a new NotFoundException.
+    * Creates a new NotFoundException.
     * 
-    * @param string
+    * @param message the message of the exception
     */
-   public NotFoundException(String exception)
+   public NotFoundException(String message)
    {
-     super(exception);
+     super(message);
    }
 
    /** The serialVersionUID */




More information about the jboss-cvs-commits mailing list