From ab834233b2e13d3307e5af73afe9faac228146b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Mat=C3=A8rne?= Date: Thu, 28 May 2015 09:43:20 +0200 Subject: [PATCH] fix javadoc --- .../org/apache/tools/ant/taskdefs/AugmentReference.java | 2 +- src/main/org/apache/tools/ant/taskdefs/Jar.java | 2 +- src/main/org/apache/tools/ant/taskdefs/Property.java | 2 +- src/main/org/apache/tools/ant/taskdefs/XSLTLiaison4.java | 3 ++- .../apache/tools/ant/taskdefs/optional/XMLValidateTask.java | 6 +++--- .../apache/tools/ant/taskdefs/optional/javacc/JJTree.java | 2 +- .../apache/tools/ant/taskdefs/optional/junit/JUnitTask.java | 2 +- .../org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.java | 2 +- src/main/org/apache/tools/ant/types/Assertions.java | 2 +- src/main/org/apache/tools/ant/types/ResourceCollection.java | 5 +++-- .../apache/tools/ant/types/resources/MultiRootFileSet.java | 5 +++-- .../types/selectors/modifiedselector/ModifiedSelector.java | 6 +++--- src/main/org/apache/tools/ant/util/DeweyDecimal.java | 2 +- src/main/org/apache/tools/tar/TarEntry.java | 4 ++-- 14 files changed, 24 insertions(+), 21 deletions(-) diff --git a/src/main/org/apache/tools/ant/taskdefs/AugmentReference.java b/src/main/org/apache/tools/ant/taskdefs/AugmentReference.java index 19c5f0f8c..637795f37 100644 --- a/src/main/org/apache/tools/ant/taskdefs/AugmentReference.java +++ b/src/main/org/apache/tools/ant/taskdefs/AugmentReference.java @@ -81,7 +81,7 @@ public class AugmentReference extends Task implements TypeAdapter { /** * Needed if two different targets reuse the same instance. - * @see https://issues.apache.org/bugzilla/show_bug.cgi?id=50894 + * @see "https://issues.apache.org/bugzilla/show_bug.cgi?id=50894" */ private synchronized void restoreWrapperId() { if (id != null) { diff --git a/src/main/org/apache/tools/ant/taskdefs/Jar.java b/src/main/org/apache/tools/ant/taskdefs/Jar.java index 865715319..c2c0f0edb 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Jar.java +++ b/src/main/org/apache/tools/ant/taskdefs/Jar.java @@ -956,7 +956,7 @@ public class Jar extends Zip { // CheckStyle:LineLength OFF - Link is too long. /** * Check against packaging spec - * @see http://java.sun.com/j2se/1.3/docs/guide/versioning/spec/VersioningSpecification.html#PackageVersioning + * @see "http://java.sun.com/j2se/1.3/docs/guide/versioning/spec/VersioningSpecification.html#PackageVersioning" */ // CheckStyle:LineLength ON private void checkJarSpec() { diff --git a/src/main/org/apache/tools/ant/taskdefs/Property.java b/src/main/org/apache/tools/ant/taskdefs/Property.java index 8efcd455e..4aee3d0f2 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Property.java +++ b/src/main/org/apache/tools/ant/taskdefs/Property.java @@ -556,7 +556,7 @@ public class Property extends Task { * @param isXml true if we should try to load from xml * @throws IOException if something goes wrong * @since 1.8.0 - * @see http://java.sun.com/dtd/properties.dtd + * @see "http://java.sun.com/dtd/properties.dtd" * @see java.util.Properties#loadFromXML(InputStream) */ private void loadProperties( diff --git a/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison4.java b/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison4.java index 5de380b70..6e16e6236 100644 --- a/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison4.java +++ b/src/main/org/apache/tools/ant/taskdefs/XSLTLiaison4.java @@ -17,6 +17,7 @@ */ package org.apache.tools.ant.taskdefs; + /** * Extends Proxy interface for XSLT processors: adds support for XSLT parameters * of various types (not only String) @@ -35,7 +36,7 @@ public interface XSLTLiaison4 extends XSLTLiaison3 { * @param value the parameter value as String, Boolean, int, etc. * @throws Exception thrown if any problems happens. * @since Ant 1.9.3 - * @see Transformer#setParameter(java.lang.String, java.lang.Object) + * @see javax.xml.transform.Transformer#setParameter(java.lang.String, java.lang.Object) */ void addParam(String name, Object value) throws Exception; } diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java index e9fed0dfd..05c043df0 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java @@ -451,8 +451,8 @@ public class XMLValidateTask extends Task { } /** - * - * @return + * Returns a SAX-based XMLReader or a SAX-based Parser. + * @return reader or parser */ private Object createDefaultReaderOrParser() { Object reader; @@ -465,7 +465,7 @@ public class XMLValidateTask extends Task { } /** - * create a reader if the use of the class did not specify another one. + * Create a reader if the use of the class did not specify another one. * If a BuildException is thrown, the caller may revert to an alternate * reader. * @return a new reader. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java b/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java index f9f23e51b..f5d126eed 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java @@ -343,7 +343,7 @@ public class JJTree extends Task { * * @param destFile * @param outputDir - * @return + * @return validation file, relative if possible; null if not set * @throws BuildException */ private String validateOutputFile(String destFile, diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java index 2df34be43..459bd3d5d 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java @@ -2256,7 +2256,7 @@ public class JUnitTask extends Task { * indicate that something went wrong with a test inside the batch * without giving it a real name.

* - * @see https://issues.apache.org/bugzilla/show_bug.cgi?id=45227 + * @see "https://issues.apache.org/bugzilla/show_bug.cgi?id=45227" */ private static JUnitTest createDummyTestForBatchTest(final JUnitTest test) { final JUnitTest t = (JUnitTest) test.clone(); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.java b/src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.java index b9cbc3023..a04dfefab 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.java @@ -194,7 +194,7 @@ public class SSHExec extends SSHBase { * setErrorOutput. Default is false, that is, overwrite * the file. * - * @param append True to append to an existing file, false to overwrite. + * @param appenderr True to append to an existing file, false to overwrite. * @since Apache Ant 1.9.4 */ public void setErrAppend(final boolean appenderr) { diff --git a/src/main/org/apache/tools/ant/types/Assertions.java b/src/main/org/apache/tools/ant/types/Assertions.java index fdb873a92..a54db501f 100644 --- a/src/main/org/apache/tools/ant/types/Assertions.java +++ b/src/main/org/apache/tools/ant/types/Assertions.java @@ -151,7 +151,7 @@ public class Assertions extends DataType implements Cloneable { /** * what is the final size of this object - * @return + * @return number of assertions */ private int getFinalSize() { return assertionList.size() + (enableSystemAssertions != null ? 1 : 0); diff --git a/src/main/org/apache/tools/ant/types/ResourceCollection.java b/src/main/org/apache/tools/ant/types/ResourceCollection.java index 0101d706f..a82c8b596 100644 --- a/src/main/org/apache/tools/ant/types/ResourceCollection.java +++ b/src/main/org/apache/tools/ant/types/ResourceCollection.java @@ -39,9 +39,10 @@ public interface ResourceCollection extends Iterable { /** * Indicate whether this ResourceCollection is composed entirely of - * Resources accessible via local filesystem conventions. If true, + * Resources accessible via local filesystem conventions. If true, * all resources returned from this collection should - * respond with a {@link FileProvider} when asked via {@link Resource#as}. + * respond with a {@link org.apache.tools.ant.types.resources.FileProvider} + * when asked via {@link Resource#as}. * @return whether this is a filesystem-only resource collection. */ boolean isFilesystemOnly(); diff --git a/src/main/org/apache/tools/ant/types/resources/MultiRootFileSet.java b/src/main/org/apache/tools/ant/types/resources/MultiRootFileSet.java index bc8635cfe..d7938908c 100644 --- a/src/main/org/apache/tools/ant/types/resources/MultiRootFileSet.java +++ b/src/main/org/apache/tools/ant/types/resources/MultiRootFileSet.java @@ -72,8 +72,8 @@ public class MultiRootFileSet extends AbstractFileSet } /** - * Adds basedirs as a comman separated list. - * @param b boolean cache flag. + * Adds basedirs as a comma separated list. + * @param dirs directories as CSV */ public void setBaseDirs(final String dirs) { if (isReference()) { @@ -89,6 +89,7 @@ public class MultiRootFileSet extends AbstractFileSet /** * Adds a basedir as nested element. + * @param r basedir */ public void addConfiguredBaseDir(final FileResource r) { if (isReference()) { diff --git a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java index f93e406a9..9f5380984 100644 --- a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java +++ b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java @@ -325,7 +325,7 @@ public class ModifiedSelector extends BaseExtendSelector } else { if (algorithmClass != null) { // use Algorithm specified by classname - algorithm = (Algorithm) loadClass( + algorithm = loadClass( algorithmClass, "is not an Algorithm.", Algorithm.class); @@ -344,7 +344,7 @@ public class ModifiedSelector extends BaseExtendSelector } else { if (cacheClass != null) { // use Cache specified by classname - cache = (Cache) loadClass(cacheClass, "is not a Cache.", Cache.class); + cache = loadClass(cacheClass, "is not a Cache.", Cache.class); } else { // nothing specified - use default cache = defaultCache; @@ -488,7 +488,7 @@ public class ModifiedSelector extends BaseExtendSelector * @param basedir as described in BaseExtendSelector * @param filename as described in BaseExtendSelector * @param cacheKey the name for the key for storing the hashvalue - * @return + * @return true if the file is selected otherwise false */ private boolean isSelected(File basedir, String filename, String cacheKey) { validate(); diff --git a/src/main/org/apache/tools/ant/util/DeweyDecimal.java b/src/main/org/apache/tools/ant/util/DeweyDecimal.java index 8e9cc44ea..003f1406a 100644 --- a/src/main/org/apache/tools/ant/util/DeweyDecimal.java +++ b/src/main/org/apache/tools/ant/util/DeweyDecimal.java @@ -212,7 +212,7 @@ public class DeweyDecimal implements Comparable { * * @param other another DeweyDecimal to compare with * @return result - * @see java.lang.Comparable#compareTo() + * @see java.lang.Comparable#compareTo(Object) */ public int compareTo(DeweyDecimal other) { final int max = Math.max(other.components.length, components.length); diff --git a/src/main/org/apache/tools/tar/TarEntry.java b/src/main/org/apache/tools/tar/TarEntry.java index 4b1223772..a9c96f13c 100644 --- a/src/main/org/apache/tools/tar/TarEntry.java +++ b/src/main/org/apache/tools/tar/TarEntry.java @@ -423,7 +423,7 @@ public class TarEntry implements TarConstants { * * @return This entry's user id. * @deprecated use #getLongUserId instead as user ids can be - * bigger than {@link Integer.MAX_INT} + * bigger than {@link Integer#MAX_VALUE} */ @Deprecated public int getUserId() { @@ -464,7 +464,7 @@ public class TarEntry implements TarConstants { * * @return This entry's group id. * @deprecated use #getLongGroupId instead as group ids can be - * bigger than {@link Integer.MAX_INT} + * bigger than {@link Integer#MAX_VALUE} */ @Deprecated public int getGroupId() {