Browse Source

fix javadoc

master
Jan Matrne 10 years ago
parent
commit
ab834233b2
14 changed files with 24 additions and 21 deletions
  1. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/AugmentReference.java
  2. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/Jar.java
  3. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/Property.java
  4. +2
    -1
      src/main/org/apache/tools/ant/taskdefs/XSLTLiaison4.java
  5. +3
    -3
      src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java
  6. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java
  7. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java
  8. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.java
  9. +1
    -1
      src/main/org/apache/tools/ant/types/Assertions.java
  10. +3
    -2
      src/main/org/apache/tools/ant/types/ResourceCollection.java
  11. +3
    -2
      src/main/org/apache/tools/ant/types/resources/MultiRootFileSet.java
  12. +3
    -3
      src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java
  13. +1
    -1
      src/main/org/apache/tools/ant/util/DeweyDecimal.java
  14. +2
    -2
      src/main/org/apache/tools/tar/TarEntry.java

+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/AugmentReference.java View File

@@ -81,7 +81,7 @@ public class AugmentReference extends Task implements TypeAdapter {


/** /**
* Needed if two different targets reuse the same instance. * 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() { private synchronized void restoreWrapperId() {
if (id != null) { if (id != null) {


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/Jar.java View File

@@ -956,7 +956,7 @@ public class Jar extends Zip {
// CheckStyle:LineLength OFF - Link is too long. // CheckStyle:LineLength OFF - Link is too long.
/** /**
* Check against packaging spec * 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 // CheckStyle:LineLength ON
private void checkJarSpec() { private void checkJarSpec() {


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/Property.java View File

@@ -556,7 +556,7 @@ public class Property extends Task {
* @param isXml <tt>true</tt> if we should try to load from xml * @param isXml <tt>true</tt> if we should try to load from xml
* @throws IOException if something goes wrong * @throws IOException if something goes wrong
* @since 1.8.0 * @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) * @see java.util.Properties#loadFromXML(InputStream)
*/ */
private void loadProperties( private void loadProperties(


+ 2
- 1
src/main/org/apache/tools/ant/taskdefs/XSLTLiaison4.java View File

@@ -17,6 +17,7 @@
*/ */
package org.apache.tools.ant.taskdefs; package org.apache.tools.ant.taskdefs;



/** /**
* Extends Proxy interface for XSLT processors: adds support for XSLT parameters * Extends Proxy interface for XSLT processors: adds support for XSLT parameters
* of various types (not only String) * 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. * @param value the parameter value as String, Boolean, int, etc.
* @throws Exception thrown if any problems happens. * @throws Exception thrown if any problems happens.
* @since Ant 1.9.3 * @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; void addParam(String name, Object value) throws Exception;
} }

+ 3
- 3
src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java View File

@@ -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() { private Object createDefaultReaderOrParser() {
Object reader; 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 * If a BuildException is thrown, the caller may revert to an alternate
* reader. * reader.
* @return a new reader. * @return a new reader.


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java View File

@@ -343,7 +343,7 @@ public class JJTree extends Task {
* *
* @param destFile * @param destFile
* @param outputDir * @param outputDir
* @return
* @return validation file, relative if possible; <tt>null</tt> if not set
* @throws BuildException * @throws BuildException
*/ */
private String validateOutputFile(String destFile, private String validateOutputFile(String destFile,


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java View File

@@ -2256,7 +2256,7 @@ public class JUnitTask extends Task {
* indicate that something went wrong with a test inside the batch * indicate that something went wrong with a test inside the batch
* without giving it a real name.</p> * without giving it a real name.</p>
* *
* @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) { private static JUnitTest createDummyTestForBatchTest(final JUnitTest test) {
final JUnitTest t = (JUnitTest) test.clone(); final JUnitTest t = (JUnitTest) test.clone();


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.java View File

@@ -194,7 +194,7 @@ public class SSHExec extends SSHBase {
* <code>setErrorOutput</code>. Default is false, that is, overwrite * <code>setErrorOutput</code>. Default is false, that is, overwrite
* the file. * 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 * @since Apache Ant 1.9.4
*/ */
public void setErrAppend(final boolean appenderr) { public void setErrAppend(final boolean appenderr) {


+ 1
- 1
src/main/org/apache/tools/ant/types/Assertions.java View File

@@ -151,7 +151,7 @@ public class Assertions extends DataType implements Cloneable {


/** /**
* what is the final size of this object * what is the final size of this object
* @return
* @return number of assertions
*/ */
private int getFinalSize() { private int getFinalSize() {
return assertionList.size() + (enableSystemAssertions != null ? 1 : 0); return assertionList.size() + (enableSystemAssertions != null ? 1 : 0);


+ 3
- 2
src/main/org/apache/tools/ant/types/ResourceCollection.java View File

@@ -39,9 +39,10 @@ public interface ResourceCollection extends Iterable<Resource> {


/** /**
* Indicate whether this ResourceCollection is composed entirely of * 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 * 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. * @return whether this is a filesystem-only resource collection.
*/ */
boolean isFilesystemOnly(); boolean isFilesystemOnly();


+ 3
- 2
src/main/org/apache/tools/ant/types/resources/MultiRootFileSet.java View File

@@ -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) { public void setBaseDirs(final String dirs) {
if (isReference()) { if (isReference()) {
@@ -89,6 +89,7 @@ public class MultiRootFileSet extends AbstractFileSet


/** /**
* Adds a basedir as nested element. * Adds a basedir as nested element.
* @param r basedir
*/ */
public void addConfiguredBaseDir(final FileResource r) { public void addConfiguredBaseDir(final FileResource r) {
if (isReference()) { if (isReference()) {


+ 3
- 3
src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java View File

@@ -325,7 +325,7 @@ public class ModifiedSelector extends BaseExtendSelector
} else { } else {
if (algorithmClass != null) { if (algorithmClass != null) {
// use Algorithm specified by classname // use Algorithm specified by classname
algorithm = (Algorithm) loadClass(
algorithm = loadClass(
algorithmClass, algorithmClass,
"is not an Algorithm.", "is not an Algorithm.",
Algorithm.class); Algorithm.class);
@@ -344,7 +344,7 @@ public class ModifiedSelector extends BaseExtendSelector
} else { } else {
if (cacheClass != null) { if (cacheClass != null) {
// use Cache specified by classname // 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 { } else {
// nothing specified - use default // nothing specified - use default
cache = defaultCache; cache = defaultCache;
@@ -488,7 +488,7 @@ public class ModifiedSelector extends BaseExtendSelector
* @param basedir as described in BaseExtendSelector * @param basedir as described in BaseExtendSelector
* @param filename as described in BaseExtendSelector * @param filename as described in BaseExtendSelector
* @param cacheKey the name for the key for storing the hashvalue * @param cacheKey the name for the key for storing the hashvalue
* @return
* @return <tt>true</tt> if the file is selected otherwise <tt>false</tt>
*/ */
private boolean isSelected(File basedir, String filename, String cacheKey) { private boolean isSelected(File basedir, String filename, String cacheKey) {
validate(); validate();


+ 1
- 1
src/main/org/apache/tools/ant/util/DeweyDecimal.java View File

@@ -212,7 +212,7 @@ public class DeweyDecimal implements Comparable<DeweyDecimal> {
* *
* @param other another DeweyDecimal to compare with * @param other another DeweyDecimal to compare with
* @return result * @return result
* @see java.lang.Comparable#compareTo()
* @see java.lang.Comparable#compareTo(Object)
*/ */
public int compareTo(DeweyDecimal other) { public int compareTo(DeweyDecimal other) {
final int max = Math.max(other.components.length, components.length); final int max = Math.max(other.components.length, components.length);


+ 2
- 2
src/main/org/apache/tools/tar/TarEntry.java View File

@@ -423,7 +423,7 @@ public class TarEntry implements TarConstants {
* *
* @return This entry's user id. * @return This entry's user id.
* @deprecated use #getLongUserId instead as user ids can be * @deprecated use #getLongUserId instead as user ids can be
* bigger than {@link Integer.MAX_INT}
* bigger than {@link Integer#MAX_VALUE}
*/ */
@Deprecated @Deprecated
public int getUserId() { public int getUserId() {
@@ -464,7 +464,7 @@ public class TarEntry implements TarConstants {
* *
* @return This entry's group id. * @return This entry's group id.
* @deprecated use #getLongGroupId instead as group ids can be * @deprecated use #getLongGroupId instead as group ids can be
* bigger than {@link Integer.MAX_INT}
* bigger than {@link Integer#MAX_VALUE}
*/ */
@Deprecated @Deprecated
public int getGroupId() { public int getGroupId() {


Loading…
Cancel
Save