- Revision
- 1275
- Author
- rfscholte
- Date
- 2011-07-26 16:01:34 -0500 (Tue, 26 Jul 2011)
Log Message
Use FQNs in javadoc, clean up imports
Modified Paths
- trunk/qdox/src/main/java/com/thoughtworks/qdox/JavaProjectBuilder.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/AbstractJavaEntity.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaAnnotatedElement.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaConstructor.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaField.java
- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaGenericDeclaration.java
Diff
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/JavaProjectBuilder.java (1274 => 1275)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/JavaProjectBuilder.java 2011-07-26 18:57:18 UTC (rev 1274) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/JavaProjectBuilder.java 2011-07-26 21:01:34 UTC (rev 1275) @@ -26,7 +26,6 @@ import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import java.io.Reader; -import java.net.URL; import java.util.LinkedList; import java.util.List; @@ -35,7 +34,6 @@ import com.thoughtworks.qdox.directorywalker.SuffixFilter; import com.thoughtworks.qdox.library.ClassLibraryBuilder; import com.thoughtworks.qdox.library.ErrorHandler; -import com.thoughtworks.qdox.library.OrderedClassLibraryBuilder; import com.thoughtworks.qdox.library.SortedClassLibraryBuilder; import com.thoughtworks.qdox.model.JavaClass; import com.thoughtworks.qdox.model.JavaPackage; @@ -53,9 +51,9 @@ * <li>Provide store and load methods for the JavaProjectBuilder</li> * <li>Provide the option to set an ErrorHandler</li> * </ul> - * By default the JavaProjectBuilder will use the {@link SortedClassLibraryBuilder}, which means it doesn't matter in + * By default the JavaProjectBuilder will use the {@link com.thoughtworks.qdox.library.SortedClassLibraryBuilder}, which means it doesn't matter in * which order you add the resources, first all sources and sourcefolders, followed by the classloaders. Another - * implementation for the ClassLibraryBuilder is the {@link OrderedClassLibraryBuilder}, which preserves the order in + * implementation for the ClassLibraryBuilder is the {@link com.thoughtworks.qdox.library.OrderedClassLibraryBuilder}, which preserves the order in * which resources are added. By creating a new JavaProjectBuilder with your own ClassLibraryBuilder you can decide * which loading strategy should be used. * @@ -115,7 +113,7 @@ /** * Sets the encoding when using Files or URL's to parse. * - * @param encoding the encoding to use for {@link File} or {@link URL} + * @param encoding the encoding to use for {@link java.io.File} or {@link java.net.URL} * @return this javaProjectBuilder itself */ public JavaProjectBuilder setEncoding( String encoding ) @@ -213,7 +211,7 @@ } /** - * Add the {@link ClassLoader} to this JavaProjectBuilder + * Add the {@link java.lang.ClassLoader} to this JavaProjectBuilder * * @param classLoader the classloader to add */
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/AbstractJavaEntity.java (1274 => 1275)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/AbstractJavaEntity.java 2011-07-26 18:57:18 UTC (rev 1274) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/AbstractJavaEntity.java 2011-07-26 21:01:34 UTC (rev 1275) @@ -19,9 +19,7 @@ * under the License. */ -import java.lang.reflect.Modifier; import java.util.Collections; -import java.util.LinkedList; import java.util.List; public abstract class AbstractJavaEntity extends AbstractBaseJavaEntity implements JavaModel { @@ -44,7 +42,7 @@ } /** - * Equivalent of {@link Modifier#isAbstract(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isAbstract(int)} * * @return <code>true</code> if entity is abstract, otherwise <code>false</code> */ @@ -53,7 +51,7 @@ } /** - * Equivalent of {@link Modifier#isPublic(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isPublic(int)} * * @return <code>true</code> if entity is public, otherwise <code>false</code> */ @@ -62,7 +60,7 @@ } /** - * Equivalent of {@link Modifier#isPrivate(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isPrivate(int)} * * @return <code>true</code> if entity is private, otherwise <code>false</code> */ @@ -71,7 +69,7 @@ } /** - * Equivalent of {@link Modifier#isProtected(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isProtected(int)} * * @return <code>true</code> if entity is protected, otherwise <code>false</code> */ @@ -80,7 +78,7 @@ } /** - * Equivalent of {@link Modifier#isStatic(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isStatic(int)} * * @return <code>true</code> if entity is static, otherwise <code>false</code> */ @@ -89,7 +87,7 @@ } /** - * Equivalent of {@link Modifier#isFinal(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isFinal(int)} * * @return <code>true</code> if entity is final, otherwise <code>false</code> */ @@ -98,7 +96,7 @@ } /** - * Equivalent of {@link Modifier#isSynchronized(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isSynchronized(int)} * * @return <code>true</code> if entity is sunchronized, otherwise <code>false</code> */ @@ -107,7 +105,7 @@ } /** - * Equivalent of {@link Modifier#isTransient(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isTransient(int)} * * @return <code>true</code> if entity is transient, otherwise <code>false</code> */ @@ -116,7 +114,7 @@ } /** - * Equivalent of {@link Modifier#isVolatile(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isVolatile(int)} * * @return <code>true</code> if entity is volatile, otherwise <code>false</code> * @since 1.4 @@ -126,7 +124,7 @@ } /** - * Equivalent of {@link Modifier#isNative(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isNative(int)} * * @return <code>true</code> if entity is native, otherwise <code>false</code> * @since 1.4 @@ -136,7 +134,7 @@ } /** - * Equivalent of {@link Modifier#isStrict(int)} + * Equivalent of {@link java.lang.reflect.Modifier#isStrict(int)} * * @return <code>true</code> if entity is strictfp, otherwise <code>false</code> * @since 1.4 @@ -146,7 +144,7 @@ } /** - * Returns <code>true</code> if one of the modifiers matches the modifier + * Returns <code>true</code> if one of the modifiers matches the {@code modifier} * * @param modifier the modifier * @return <code>true</code> if the modifier is present, otherwise <code>false</code>
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaAnnotatedElement.java (1274 => 1275)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaAnnotatedElement.java 2011-07-26 18:57:18 UTC (rev 1274) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaAnnotatedElement.java 2011-07-26 21:01:34 UTC (rev 1275) @@ -24,14 +24,11 @@ /** * <p> * 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}. + * Where the original AnnotatedElement uses an Array, the JavaAnnotatedElement 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. * </p> - * <p> - * Some methods were already part of some implementations, which might result in an earlier version then this interface. - * </p> * * @author Robert Scholte * @since 2.0
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaConstructor.java (1274 => 1275)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaConstructor.java 2011-07-26 18:57:18 UTC (rev 1274) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaConstructor.java 2011-07-26 21:01:34 UTC (rev 1275) @@ -20,14 +20,13 @@ */ import java.io.Serializable; -import java.lang.reflect.Constructor; import java.util.List; /** - * Modeled equivalent of {@link Constructor}, providing the most important methods. - * Where the original {@link Constructor} is using an Array, this model is using a {@link List}. + * Modeled equivalent of {@link java.lang.reflect.Constructor}, providing the most important methods. + * Where the original Constructor is using an Array, this model is using a {@link List}. * - * @author Robert + * @author Robert Scholte * @since 2.0 */ public interface JavaConstructor @@ -36,7 +35,7 @@ // Methods from Constructor /** - * Equivalent of {@link Constructor#getParameterTypes()}, where a JavaParameter also contains the original name if available. + * Equivalent of {@link java.lang.reflect.Constructor#getParameterTypes()}, where a JavaParameter also contains the original name if available. * * @return a list of JavaParameters, never <code>null</code> */ @@ -50,21 +49,21 @@ JavaParameter getParameterByName( String name ); /** - * Equivalent of {@link Constructor#getParameterTypes()} + * Equivalent of {@link java.lang.reflect.Constructor#getParameterTypes()} * * @return a list of JavaParameters, never <code>null</code> */ List<Type> getParameterTypes(); /** - * Equivalent of {@link Constructor#getExceptionTypes()} + * Equivalent of {@link java.lang.reflect.Constructor#getExceptionTypes()} * * @return a list of Exceptions, never <code>null</code> */ List<Type> getExceptions(); /** - * Equivalent of {@link Constructor#isVarArgs()} + * Equivalent of {@link java.lang.reflect.Constructor#isVarArgs()} * * @return <code>true</code> if the final parameter is a varArg, otherwise <code>false</code> */
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaField.java (1274 => 1275)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaField.java 2011-07-26 18:57:18 UTC (rev 1274) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaField.java 2011-07-26 21:01:34 UTC (rev 1275) @@ -1,8 +1,5 @@ package com.thoughtworks.qdox.model; -import java.lang.reflect.Field; -import java.util.List; - /* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file @@ -23,8 +20,8 @@ */ /** - * Modeled equivalent of {@link Field}, providing the most important methods. - * Where the original {@link Field} is using an Array, this model is using a {@link List}. + * Modeled equivalent of {@link java.lang.reflect.Field}, providing the most important methods. + * Where the original Field is using an Array, this model is using a {@link java.util.List}. * */ public interface JavaField extends JavaAnnotatedElement, JavaMember, JavaModel @@ -32,7 +29,7 @@ // Methods of Field /** - * Equivalent of {@link Field#getType()} + * Equivalent of {@link java.lang.reflect.Field#getType()} * * @return the type of this field, should never be <code>null</code>. */
Modified: trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaGenericDeclaration.java (1274 => 1275)
--- trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaGenericDeclaration.java 2011-07-26 18:57:18 UTC (rev 1274) +++ trunk/qdox/src/main/java/com/thoughtworks/qdox/model/JavaGenericDeclaration.java 2011-07-26 21:01:34 UTC (rev 1275) @@ -19,12 +19,11 @@ * under the License. */ -import java.lang.reflect.GenericDeclaration; import java.util.List; /** - * Modeled equivalent of {@link GenericDeclaration}. - * Where the original {@link GenericDeclaration} is using an Array, this model is using a {@link List}. + * Equivalent of {@link java.lang.reflect.GenericDeclaration}. + * Where the original GenericDeclaration uses an Array, the JavaGenericDeclaration is using a {@link List}. * * @author Robert Scholte * @since 2.0 @@ -32,7 +31,7 @@ public interface JavaGenericDeclaration { /** - * Equivalent of {@link GenericDeclaration#getTypeParameters()} + * Equivalent of {@link java.lang.reflect.GenericDeclaration#getTypeParameters()} * * @return a list of typeParameters, never <code>null</code> */
To unsubscribe from this list please visit:
