diff --git a/src/main/org/apache/tools/ant/taskdefs/Javadoc.java b/src/main/org/apache/tools/ant/taskdefs/Javadoc.java
index 253247c73..818f0c990 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Javadoc.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Javadoc.java
@@ -257,7 +257,8 @@ public class Javadoc extends Task {
}
/**
- * @see java.lang.Object#toString
+ * Return a string rep for this object.
+ * @return the package name.
*/
public String toString() {
return getName();
@@ -341,7 +342,7 @@ public class Javadoc extends Task {
*/
public static class AccessType extends EnumeratedAttribute {
/**
- * @see EnumeratedAttribute#getValues().
+ * @return the allowed values for the access type.
*/
public String[] getValues() {
// Protected first so if any GUI tool offers a default
@@ -359,9 +360,18 @@ public class Javadoc extends Task {
*/
public class ResourceCollectionContainer {
private ArrayList rcs = new ArrayList();
+ /**
+ * Add a resource collection to the container.
+ * @param rc the collection to add.
+ */
public void add(ResourceCollection rc) {
rcs.add(rc);
}
+
+ /**
+ * Get an iterator on the collection.
+ * @return an iterator.
+ */
private Iterator iterator() {
return rcs.iterator();
}
@@ -1227,6 +1237,7 @@ public class Javadoc extends Task {
/**
* should Ant resolve the link attribute relative to the
* current basedir?
+ * @return the resolveLink attribute.
*/
public boolean shouldResolveLink() {
return resolveLink;
@@ -1507,10 +1518,11 @@ public class Javadoc extends Task {
public void setSource(String source) {
this.source = source;
}
-
+
/**
* Sets the actual executable command to invoke, instead of the binary
* javadoc found in Ant's JDK.
+ * @param executable the command to invoke.
* @since Ant 1.6.3
*/
public void setExecutable(String executable) {
@@ -1547,6 +1559,7 @@ public class Javadoc extends Task {
* Adds a container for resource collections.
*
* All included files will be added as sourcefiles.
+ * @return the source files to configure.
* @since 1.7
*/
public ResourceCollectionContainer createSourceFiles() {
@@ -1586,6 +1599,7 @@ public class Javadoc extends Task {
/**
* If set to true, Ant will also accept packages that only hold
* package.html files but no Java sources.
+ * @param b a boolean value.
* @since Ant 1.6.3
*/
public void setIncludeNoSourcePackages(boolean b) {
@@ -1598,15 +1612,16 @@ public class Javadoc extends Task {
*/
public void execute() throws BuildException {
if ("javadoc2".equals(getTaskType())) {
- log("Warning: the task name is deprecated. Use instead.", Project.MSG_WARN);
+ log("Warning: the task name is deprecated. Use instead.",
+ Project.MSG_WARN);
}
// Whether *this VM* is 1.4+ (but also check executable != null).
boolean javadoc4 =
- !JavaEnvUtils.isJavaVersion(JavaEnvUtils.JAVA_1_2) &&
- !JavaEnvUtils.isJavaVersion(JavaEnvUtils.JAVA_1_3);
- boolean javadoc5 = javadoc4 &&
- !JavaEnvUtils.isJavaVersion(JavaEnvUtils.JAVA_1_4);
+ !JavaEnvUtils.isJavaVersion(JavaEnvUtils.JAVA_1_2)
+ && !JavaEnvUtils.isJavaVersion(JavaEnvUtils.JAVA_1_3);
+ boolean javadoc5 = javadoc4
+ && !JavaEnvUtils.isJavaVersion(JavaEnvUtils.JAVA_1_4);
Vector packagesToDoc = new Vector();
Path sourceDirs = new Path(getProject());
@@ -1746,7 +1761,7 @@ public class Javadoc extends Task {
}
String link = null;
if (la.shouldResolveLink()) {
- File hrefAsFile =
+ File hrefAsFile =
getProject().resolveFile(la.getHref());
if (hrefAsFile.exists()) {
try {
@@ -1754,7 +1769,7 @@ public class Javadoc extends Task {
.toExternalForm();
} catch (MalformedURLException ex) {
// should be impossible
- log("Warning: link location was invalid "
+ log("Warning: link location was invalid "
+ hrefAsFile, Project.MSG_WARN);
}
}
@@ -1778,7 +1793,7 @@ public class Javadoc extends Task {
File packageListLocation = la.getPackagelistLoc();
if (packageListLocation == null) {
throw new BuildException("The package list"
- + " location for link "
+ + " location for link "
+ la.getHref()
+ " must be provided "
+ "because the link is "
@@ -1874,7 +1889,7 @@ public class Javadoc extends Task {
// The tag element is used as a
// fileset. Parse all the files and create
// -tag arguments.
- DirectoryScanner tagDefScanner =
+ DirectoryScanner tagDefScanner =
ta.getDirectoryScanner(getProject());
String[] files = tagDefScanner.getIncludedFiles();
for (int i = 0; i < files.length; i++) {
@@ -1916,7 +1931,7 @@ public class Javadoc extends Task {
}
}
- String sourceArg = source != null ? source
+ String sourceArg = source != null ? source
: getProject().getProperty(MagicNames.BUILD_JAVAC_SOURCE);
if (sourceArg != null) {
toExecute.createArgument().setValue("-source");
@@ -2008,7 +2023,8 @@ public class Javadoc extends Task {
SourceFile sf = (SourceFile) e.nextElement();
String sourceFileName = sf.getFile().getAbsolutePath();
if (useExternalFile) {
- // XXX what is the following doing? should it run if !javadoc4 && executable != null?
+ // XXX what is the following doing?
+ // should it run if !javadoc4 && executable != null?
if (javadoc4 && sourceFileName.indexOf(" ") > -1) {
String name = sourceFileName;
if (File.separatorChar == '\\') {
@@ -2163,7 +2179,7 @@ public class Javadoc extends Task {
}
return buf.toString();
}
-
+
/**
* Add the files matched by the nested source files to the Vector
* as SourceFile instances.
@@ -2269,7 +2285,7 @@ public class Javadoc extends Task {
String[] files = pd.list(new FilenameFilter () {
public boolean accept(File dir1, String name) {
return name.endsWith(".java")
- || (includeNoSourcePackages
+ || (includeNoSourcePackages
&& name.equals("package.html"));
}
});
diff --git a/src/main/org/apache/tools/ant/taskdefs/LogOutputStream.java b/src/main/org/apache/tools/ant/taskdefs/LogOutputStream.java
index ec2fe836b..af9dd4d1c 100644
--- a/src/main/org/apache/tools/ant/taskdefs/LogOutputStream.java
+++ b/src/main/org/apache/tools/ant/taskdefs/LogOutputStream.java
@@ -90,6 +90,10 @@ public class LogOutputStream extends LineOrientedOutputStream {
pc.log(line, level);
}
+ /**
+ * Get the level.
+ * @return the log level.
+ */
public int getMessageLevel() {
return level;
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/MacroDef.java b/src/main/org/apache/tools/ant/taskdefs/MacroDef.java
index 9ad820bd8..237bc2811 100644
--- a/src/main/org/apache/tools/ant/taskdefs/MacroDef.java
+++ b/src/main/org/apache/tools/ant/taskdefs/MacroDef.java
@@ -763,9 +763,8 @@ public class MacroDef extends AntlibDefinition {
/** {@inheritDoc}. */
protected boolean equals(Member m) {
TemplateElement t = (TemplateElement) m;
- return super.equals(m) &&
- optional == t.optional &&
- implicit == t.implicit;
+ return super.equals(m)
+ && optional == t.optional && implicit == t.implicit;
}
/**
diff --git a/src/main/org/apache/tools/ant/taskdefs/MakeUrl.java b/src/main/org/apache/tools/ant/taskdefs/MakeUrl.java
index 32203c7e7..4dbc35ef8 100644
--- a/src/main/org/apache/tools/ant/taskdefs/MakeUrl.java
+++ b/src/main/org/apache/tools/ant/taskdefs/MakeUrl.java
@@ -73,17 +73,18 @@ public class MakeUrl extends Task {
*/
private boolean validate = true;
- /**
- * error message
- */
+ // error message strings
+ /** Missing file */
public static final String ERROR_MISSING_FILE = "A source file is missing :";
+ /** No property defined */
public static final String ERROR_NO_PROPERTY = "No property defined";
+ /** No files defined */
public static final String ERROR_NO_FILES = "No files defined";
/**
* set the name of a property to fill with the URL
*
- * @param property
+ * @param property the name of the property.
*/
public void setProperty(String property) {
this.property = property;
@@ -92,7 +93,7 @@ public class MakeUrl extends Task {
/**
* the name of a file to be converted into a URL
*
- * @param file
+ * @param file the file to be converted.
*/
public void setFile(File file) {
this.file = file;
@@ -102,7 +103,7 @@ public class MakeUrl extends Task {
* a fileset of jar files to include in the URL, each
* separated by the separator
*
- * @param fileset
+ * @param fileset the fileset to be added.
*/
public void addFileSet(FileSet fileset) {
filesets.add(fileset);
@@ -111,7 +112,7 @@ public class MakeUrl extends Task {
/**
* set the separator for the multi-url option.
*
- * @param separator
+ * @param separator the separator to use.
*/
public void setSeparator(String separator) {
this.separator = separator;
@@ -121,7 +122,7 @@ public class MakeUrl extends Task {
* set this flag to trigger validation that every named file exists.
* Optional: default=true
*
- * @param validate
+ * @param validate a boolean value.
*/
public void setValidate(boolean validate) {
this.validate = validate;
@@ -131,7 +132,7 @@ public class MakeUrl extends Task {
* add a path to the URL. All elements in the path
* will be converted to individual URL entries
*
- * @param path
+ * @param path a path value.
*/
public void addPath(Path path) {
paths.add(path);
diff --git a/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java b/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java
index d21e17798..84f7fb4d9 100644
--- a/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java
+++ b/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java
@@ -58,9 +58,7 @@ public abstract class MatchingTask extends Task implements SelectorContainer {
protected FileSet fileset = new FileSet();
- /**
- * @see org.apache.tools.ant.ProjectComponent#setProject
- */
+ /** {@inheritDoc}. */
public void setProject(Project project) {
super.setProject(project);
fileset.setProject(project);
diff --git a/src/main/org/apache/tools/ant/taskdefs/Move.java b/src/main/org/apache/tools/ant/taskdefs/Move.java
index 12688a97f..041f93526 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Move.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Move.java
@@ -63,7 +63,7 @@ public class Move extends Copy {
setOverwrite(true);
}
- // inherit doc
+ /** {@inheritDoc}. */
protected void validateAttributes() throws BuildException {
if (file != null && file.isDirectory()) {
if ((destFile != null && destDir != null)
diff --git a/src/main/org/apache/tools/ant/taskdefs/PathConvert.java b/src/main/org/apache/tools/ant/taskdefs/PathConvert.java
index a3cfb9b48..2a229bcfe 100644
--- a/src/main/org/apache/tools/ant/taskdefs/PathConvert.java
+++ b/src/main/org/apache/tools/ant/taskdefs/PathConvert.java
@@ -213,6 +213,7 @@ public class PathConvert extends Task {
* Set targetos to a platform to one of
* "windows", "unix", "netware", or "os/2";
* current platform settings are used by default.
+ * @param target the target os.
* @deprecated since 1.5.x.
* Use the method taking a TargetOs argument instead.
* @see #setTargetos(PathConvert.TargetOs)
diff --git a/src/main/org/apache/tools/ant/taskdefs/Property.java b/src/main/org/apache/tools/ant/taskdefs/Property.java
index ce93c91f1..01848f74a 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Property.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Property.java
@@ -334,7 +334,7 @@ public class Property extends Task {
/**
* @param userProperty ignored
* @deprecated since 1.5.x.
- * This was never a supported feature and has been
+ * This was never a supported feature and has been
* deprecated without replacement.
* @ant.attribute ignore="true"
*/
diff --git a/src/main/org/apache/tools/ant/taskdefs/compilers/AptCompilerAdapter.java b/src/main/org/apache/tools/ant/taskdefs/compilers/AptCompilerAdapter.java
index d2b1f0f18..119df9435 100644
--- a/src/main/org/apache/tools/ant/taskdefs/compilers/AptCompilerAdapter.java
+++ b/src/main/org/apache/tools/ant/taskdefs/compilers/AptCompilerAdapter.java
@@ -156,7 +156,7 @@ public class AptCompilerAdapter extends DefaultCompilerAdapter {
/**
* Run the compilation.
- * @retrun true on success.
+ * @return true on success.
* @throws BuildException if the compilation has problems.
*/
public boolean execute() throws BuildException {