- Revision
- 1272
- Author
- rfscholte
- Date
- 2011-07-25 15:47:53 -0500 (Mon, 25 Jul 2011)
Log Message
Fix javadoc, removed all warnings
Modified Paths
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DefaultJavaClass.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DefaultJavaField.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DocletTag.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaAnnotatedElement.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaClass.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMember.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMethod.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaSource.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/Type.java
Diff
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DefaultJavaClass.java (1271 => 1272)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DefaultJavaClass.java 2011-07-24 12:37:17 UTC (rev 1271) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DefaultJavaClass.java 2011-07-25 20:47:53 UTC (rev 1272) @@ -641,8 +641,9 @@ return false; } - /** - * @since 1.3 + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.model.JavaClass#isA(com.thoughtworks.qdox.model.JavaClass) */ public boolean isA(JavaClass javaClass) { if (this == javaClass) @@ -799,7 +800,7 @@ } /** - * @see http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html#toString() + * @see java.lang.Class#toString() */ @Override public String toString()
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DefaultJavaField.java (1271 => 1272)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DefaultJavaField.java 2011-07-24 12:37:17 UTC (rev 1271) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DefaultJavaField.java 2011-07-25 20:47:53 UTC (rev 1272) @@ -36,10 +36,9 @@ this.type = type; } - /** - * Retrieve the class containing this field - * - * @return the declaring class + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.model.JavaMember#getDeclaringClass() */ public JavaClass getDeclaringClass() { return getParentClass(); @@ -90,11 +89,10 @@ return getName(); } - /** - * This value represents an assignment to the name. - * It can hold a primitive, Object of field reference of any class. - * - * @return the _expression_, otherwise <code>null</code> + + /* + * (non-Javadoc) + * @see com.thoughtworks.qdox.model.JavaField#getInitializationExpression() */ public String getInitializationExpression(){ return initializationExpression; @@ -105,7 +103,7 @@ } /** - * @see http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Field.html#toString() + * @see java.lang.reflect.Field#toString() */ public String toString() { StringBuffer result = new StringBuffer();
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DocletTag.java (1271 => 1272)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DocletTag.java 2011-07-24 12:37:17 UTC (rev 1271) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/DocletTag.java 2011-07-25 20:47:53 UTC (rev 1272) @@ -47,13 +47,12 @@ /** * @param key name of a named-parameter - * @return the corresponding value, - * or null if no such named-parameter was present + * @return the matching value, otherwise <code>null</code> */ String getNamedParameter(String key); /** - * @return a Map containing all the named-parameters + * @return a Map containing all the named-parameters, never <code>null</code> */ Map<String, String> getNamedParameterMap();
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaAnnotatedElement.java (1271 => 1272)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaAnnotatedElement.java 2011-07-24 12:37:17 UTC (rev 1271) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaAnnotatedElement.java 2011-07-25 20:47:53 UTC (rev 1272) @@ -19,13 +19,12 @@ * under the License. */ -import java.lang.reflect.AnnotatedElement; import java.util.List; /** * <p> - * Modeled equivalent of {@link AnnotatedElement}, providing the most important methods. - * Where the original {@link AnnotatedElement} is using an Array, this model is using a {@link List}. + * Equivalent of {@link java.lang.reflect.AnnotatedElement}, providing the most important methods. + * Where the original AnnotatedElement is using an Array, this model is using a {@link List}. * </p> * <p> * Where you can use Annotations, you can also use JavaDoc. For that reason all JavaDoc methods have been added to this interface. @@ -44,9 +43,9 @@ /** * - * Equivalent of {@link AnnotatedElement#getAnnotations()} + * Equivalent of {@link java.lang.reflect.AnnotatedElement#getAnnotations()} * - * @return + * @return a list of Annotations, never <code>null</code> */ List<Annotation> getAnnotations(); @@ -88,6 +87,9 @@ * Convenience method for <code>getTagByName(String).getNamedParameter(String)</code> * that also checks for null tag. * + * @param tagName the tag name + * @param parameterName the parameter name + * @return the value of the matching parameter, otherwise <code>null</code> * @since 1.3 */ String getNamedParameter(String tagName, String parameterName);
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaClass.java (1271 => 1272)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaClass.java 2011-07-24 12:37:17 UTC (rev 1271) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaClass.java 2011-07-25 20:47:53 UTC (rev 1272) @@ -24,7 +24,7 @@ import com.thoughtworks.qdox.library.ClassLibrary; /** - * Modeled equivalent of {@link Class}, providing the most important methods. + * Equivalent of {@link java.lang.Class}, providing the most important methods. * Where the original Class is using an Array, this model is using a List. * * @author Robert Scholte @@ -122,8 +122,9 @@ /** * The name can be both absolute (including the package) or relative (matching a subclass or an import). * - * @param name - * @return + * @param name the name to resolve + * @return the resolved canonical name, otherwise <code>null</code> + * @since 2.0 */ String resolveCanonicalName( String name ); @@ -131,7 +132,8 @@ * The name can be both absolute (including the package) or relative (matching a subclass or an import). * * @param name the name to resolve - * @return the resolved fully qualified name, otherwise <code>null</code> + * @return the resolved fully qualified name, otherwise <code>null</code> + * @since 2.0 */ String resolveFullyQualifiedName( String name ); @@ -158,17 +160,17 @@ /** * - * @param parameterTypes - * @return the constructor matching the parameterTypes, otherwise <code>null</code> + * @param parameterTypes the parameter types of the constructor, can be <code>null</code> + * @return the matching constructor, otherwise <code>null</code> * @since 2.0 */ JavaConstructor getConstructor(List<Type> parameterTypes); /** * - * @param parameterTypes - * @param varArg - * @return the constructor matching the parameterTypes and the varArg, otherwise <code>null</code> + * @param parameterTypes the parameter types of the constructor, can be <code>null</code> + * @param varArg define is the constructor has varArgs + * @return the matching constructor, otherwise <code>null</code> * @since 2.0 */ JavaConstructor getConstructor(List<Type> parameterTypes, boolean varArg); @@ -181,57 +183,57 @@ /** * - * @param name method name - * @param parameterTypes parameter types or null if there are no parameters. - * @return the matching method or null if no match is found. + * @param name the name of the method + * @param parameterTypes the parameter types of the method, can be <code>null</code>. + * @return the matching method, otherwise <code>null</code> */ JavaMethod getMethodBySignature( String name, List<Type> parameterTypes ); /** - * This should be the signature for getMethodBySignature + * This should be the signature for getMethodBySignature. * - * @param name - * @param parameterTypes - * @param varArgs - * @return + * @param name the name of the method + * @param parameterTypes the parameter types of the method, can be <code>null<code> + * @param varArgs define if the method has varArgs + * @return the matching method, otherwise <code>null</code> */ JavaMethod getMethod( String name, List<Type> parameterTypes, boolean varArgs ); /** * - * @param name - * @param parameterTypes - * @param superclasses - * @return + * @param name the name of the method + * @param parameterTypes the parameter types of the method, can be <code>null</code> + * @param superclasses to define if superclasses should be included as well + * @return the matching method, otherwise <code>null</code> */ JavaMethod getMethodBySignature( String name, List<Type> parameterTypes, boolean superclasses ); /** * - * @param name - * @param parameterTypes + * @param name the name of the method + * @param parameterTypes the parameter types of the method, can be <code>null<code> * @param superclasses - * @param varArg - * @return + * @param varArg define if the method has varArgs + * @return the matching method, otherwise <code>null</code> */ JavaMethod getMethodBySignature( String name, List<Type> parameterTypes, boolean superclasses, boolean varArg ); /** * - * @param name - * @param parameterTypes - * @param superclasses - * @return + * @param name the name of the method + * @param parameterTypes the parameter types of the method, can be <code>null<code> + * @param superclasses to define if superclasses should be included as well + * @return the matching methods, otherwise <code>null</code> */ List<JavaMethod> getMethodsBySignature( String name, List<Type> parameterTypes, boolean superclasses ); /** * - * @param name - * @param parameterTypes - * @param superclasses - * @param varArg - * @return + * @param name the name of the method + * @param parameterTypes the parameter types of the method, can be <code>null<code> + * @param superclasses to define if superclasses should be included as well + * @param varArg define if the method has varArgs + * @return the matching methods, otherwise <code>null</code> */ List<JavaMethod> getMethodsBySignature( String name, List<Type> parameterTypes, boolean superclasses, boolean varArg ); @@ -261,6 +263,7 @@ boolean isA( String fullClassName ); /** + * @param javaClass * @since 1.3 */ boolean isA( JavaClass javaClass ); @@ -273,6 +276,8 @@ List<BeanProperty> getBeanProperties(); /** + * + * @param superclasses to define if superclasses should be included as well * @since 1.3 */ List<BeanProperty> getBeanProperties( boolean superclasses ); @@ -280,11 +285,15 @@ /** * Gets bean property without looking in superclasses or interfaces. * + * @param propertyName the name of the property * @since 1.3 */ BeanProperty getBeanProperty( String propertyName ); /** + * @param propertyName the name of the property + * @param superclasses to define if superclasses should be included as well + * * @since 1.3 */ BeanProperty getBeanProperty( String propertyName, boolean superclasses ); @@ -322,9 +331,10 @@ * <pre> * private String fieldA; // getValue() will return "String" * private java.lang.String fieldA; // getValue() will return "java.lang.String" + * private List<String> aList; // getValue() will return "List" * </pre> * - * @return the name of the class as used in the source source + * @return the name of the class as used in the source */ String getValue(); @@ -332,7 +342,13 @@ * A java5+ representation of the class. * When including all imports, you should be safe to use this method. * - * @return + * Examples: + * <pre> + * private String fieldA; // getValue() will return "String" + * private java.lang.String fieldA; // getValue() will return "java.lang.String" + * private List<String> aList; // getValue() will return "List<String>" + * </pre> * + * @return the generic name of the class as used in the source */ String getGenericValue();
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMember.java (1271 => 1272)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMember.java 2011-07-24 12:37:17 UTC (rev 1271) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMember.java 2011-07-25 20:47:53 UTC (rev 1272) @@ -44,7 +44,7 @@ /** * Equivalent of {@link java.lang.reflect.Member#getDeclaringClass()} * - * @return + * @return the declaring class */ JavaClass getDeclaringClass();
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMethod.java (1271 => 1272)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMethod.java 2011-07-24 12:37:17 UTC (rev 1271) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaMethod.java 2011-07-25 20:47:53 UTC (rev 1272) @@ -19,7 +19,6 @@ * under the License. */ -import java.lang.reflect.Method; import java.util.List; public interface JavaMethod extends JavaAnnotatedElement, JavaMember, JavaModel, JavaGenericDeclaration @@ -39,7 +38,7 @@ List<Type> getExceptions(); /** - * Equivalent of {@link Method#isVarArgs()} + * Equivalent of {@link java.lang.reflect.Method#isVarArgs()} * * @return <code>true</code> if this method was declared to take a variable number of arguments, * otherwise <code>false</code> @@ -61,17 +60,17 @@ /** * This method is NOT varArg aware. * - * @param name - * @param parameterTypes - * @return + * @param name the name of the method + * @param parameterTypes the parameter types of the method, can be <code>null</code> + * @return <code>true</code> if this method matches the signature, otherwise <code>false</code> */ boolean signatureMatches( String name, List<Type> parameterTypes ); /** - * @param name method name - * @param parameterTypes parameter types or null if there are no parameters. + * @param name the name of the method + * @param parameterTypes the parameter types, can be <code>null</code> * @param varArg <code>true</code> is signature should match a varArg-method, otherwise <code>false</code> - * @return true if the signature and parameters match. + * @return <code>true</code> if this method matches the signature, otherwise <code>false</code> */ boolean signatureMatches( String name, List<Type> parameterTypes, boolean varArg ); @@ -135,7 +134,7 @@ /** * Equivalent of java.lang.reflect.Method.getGenericReturnType() * - * @return the generic returntype + * @return the generic return type * @since 1.12 */ Type getGenericReturnType(); @@ -143,7 +142,7 @@ /** * Equivalent of java.lang.reflect.Method.getReturnType() * - * @return + * @return the return type * @since 1.12 */ Type getReturnType(); @@ -151,15 +150,15 @@ /** * If a class inherits this method from a generic class or interface, you can use this method to get the resolved return type * - * @param resolve - * @return + * @param resolve define if generic should be resolved + * @return the return type * @since 1.12 */ Type getReturnType( boolean resolve ); /** * - * @return the parameter types as array + * @return the parameter types * @since 1.12 */ List<Type> getParameterTypes(); @@ -168,7 +167,7 @@ * If a class inherits this method from a generic class or interface, you can use this method to get the resolved parameter types * * @param resolve - * @return the parameter types as array + * @return the parameter types * @since 1.12 */ List<Type> getParameterTypes( boolean resolve );
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaSource.java (1271 => 1272)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaSource.java 2011-07-24 12:37:17 UTC (rev 1271) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaSource.java 2011-07-25 20:47:53 UTC (rev 1272) @@ -54,14 +54,14 @@ /** * A List with all direct classes of this source, never <code>null</code> * - * @return + * @return a list of JavaClasses, never <code>null</code> */ List<JavaClass> getClasses(); /** * Complete code representation of this source * - * @return + * @return the code block of this source */ String getCodeBlock(); @@ -70,7 +70,7 @@ /** * If there's a package, return the packageName, followed by a dot, otherwise an empty String * - * @return + * @return the class name prefix, otherwise an empty String */ String getClassNamePrefix(); @@ -78,7 +78,7 @@ * Try to get the JavaClass child based on its name relative to the package. * This doesn't try to resolve it by recursion. * - * @return the resolved JavaClass or <code>null</code> + * @return the resolved JavaClass, otherwise <code>null</code> */ JavaClass getNestedClassByName( String name ); @@ -97,7 +97,7 @@ /** * Returns the name of the package or an empty String if there's no package * - * @return the name + * @return the package name, otherwise an empty String */ String getPackageName();
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/Type.java (1271 => 1272)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/Type.java 2011-07-24 12:37:17 UTC (rev 1271) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/Type.java 2011-07-25 20:47:53 UTC (rev 1272) @@ -199,11 +199,6 @@ return result; } - /** - * Checks if the FQN of this Type is resolved - * - * @return - */ protected boolean isResolved() { if (fullName == null && context != null) { fullName = context.resolveType(name); @@ -357,13 +352,6 @@ return "void".equals(getValue()); } - /** - * - * @param parentClass - * @param subclass - * @return - * @since 1.12 - */ protected Type resolve( JavaClass parentClass, JavaClass subclass ) { Type result = this;
To unsubscribe from this list please visit:
