From 69846bc44149aae7c2f7c24a3a6f60d0b26226c5 Mon Sep 17 00:00:00 2001 From: Jon Skeet Date: Mon, 25 Feb 2002 15:33:20 +0000 Subject: [PATCH] First pass of JavaDoc work just to get rid of warnings. When this is complete, whole source tree should JavaDoc (with 1.4) with no warnings. (With JDK1.3.1 the 1.4-regexp stuff generates warnings, but that's all.) git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@271545 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/tools/ant/TaskContainer.java | 22 +++++++++++-------- .../apache/tools/ant/listener/MailLogger.java | 1 - .../apache/tools/ant/taskdefs/KeySubst.java | 4 +++- .../apache/tools/ant/taskdefs/LoadFile.java | 1 - .../taskdefs/optional/junit/JUnitTask.java | 2 +- .../optional/junit/XMLResultAggregator.java | 4 ++-- .../optional/junit/Xalan1Executor.java | 2 +- .../tools/ant/types/CommandlineJava.java | 6 ++--- .../org/apache/tools/ant/types/FilterSet.java | 3 --- .../tools/ant/types/RegularExpression.java | 2 +- .../apache/tools/ant/types/Substitution.java | 2 +- .../tools/ant/util/PackageNameMapper.java | 1 - .../tools/ant/util/regexp/RegexpFactory.java | 7 +++--- 13 files changed, 29 insertions(+), 28 deletions(-) diff --git a/src/main/org/apache/tools/ant/TaskContainer.java b/src/main/org/apache/tools/ant/TaskContainer.java index 46cd33a24..e8a47c7b6 100644 --- a/src/main/org/apache/tools/ant/TaskContainer.java +++ b/src/main/org/apache/tools/ant/TaskContainer.java @@ -1,7 +1,7 @@ /* * The Apache Software License, Version 1.1 * - * Copyright (c) 2001 The Apache Software Foundation. All rights + * Copyright (c) 2001-2002 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without @@ -55,20 +55,24 @@ package org.apache.tools.ant; /** - * Interface for objects which can contain tasks - * - *

It is recommended that implementations call {@link Task#perform - * perform} instead of {@link Task#execute execute} for the tasks they - * contain, as this method ensures that {@link BuildEvent BuildEvents} - * will be generated.

+ * Interface for objects which can contain tasks. + *

+ * It is recommended that implementations call perform rather than + * execute for the tasks they contain, as this method ensures that the + * appropriate BuildEvents will be generated. * + * @see Task#perform + * @see Task#execute + * @see BuildEvent + * * @author Conor MacNeill */ public interface TaskContainer { /** - * Add a task to this task container + * Adds a task to this task container * - * @param task the task to be added to this container + * @param task The task to be added to this container. + * Must not be null. */ void addTask(Task task); } diff --git a/src/main/org/apache/tools/ant/listener/MailLogger.java b/src/main/org/apache/tools/ant/listener/MailLogger.java index 43ff5929d..1038e6bc2 100644 --- a/src/main/org/apache/tools/ant/listener/MailLogger.java +++ b/src/main/org/apache/tools/ant/listener/MailLogger.java @@ -95,7 +95,6 @@ import org.apache.tools.mail.MailMessage; * file will override Ant properties. * *@author Erik Hatcher ehatcher@apache.org - *@created December 12, 2001 */ public class MailLogger extends DefaultLogger { diff --git a/src/main/org/apache/tools/ant/taskdefs/KeySubst.java b/src/main/org/apache/tools/ant/taskdefs/KeySubst.java index 3ba553535..7fbfee4e7 100644 --- a/src/main/org/apache/tools/ant/taskdefs/KeySubst.java +++ b/src/main/org/apache/tools/ant/taskdefs/KeySubst.java @@ -140,6 +140,8 @@ public class KeySubst extends Task { this.sep = sep; } /** + * Sets the keys. + * Format string is like this:

name=value*name2=value @@ -184,7 +186,7 @@ public class KeySubst extends Task { /** Does replacement on text using the hashtable of keys. - @returns the string with the replacements in it. + @return the string with the replacements in it. */ public static String replace ( String origString, Hashtable keys ) throws BuildException diff --git a/src/main/org/apache/tools/ant/taskdefs/LoadFile.java b/src/main/org/apache/tools/ant/taskdefs/LoadFile.java index e17b8a973..cb914f811 100644 --- a/src/main/org/apache/tools/ant/taskdefs/LoadFile.java +++ b/src/main/org/apache/tools/ant/taskdefs/LoadFile.java @@ -64,7 +64,6 @@ import java.io.*; * Load a file into a property * * @author Steve Loughran - * @created 10 December 2001 */ public class LoadFile extends Task { 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 fdf9d8097..3b6e57c0d 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 @@ -357,7 +357,7 @@ public class JUnitTask extends Task { } /** - * Use a completely new environment + * Use a completely new environment. * *

Will be ignored if we are not forking a new VM. * diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java index e3049cdef..8638da740 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java @@ -105,7 +105,7 @@ public class XMLResultAggregator extends Task implements XMLConstants { protected Vector transformers = new Vector(); - /** the default directory: .. It is resolved from the project directory */ + /** The default directory: .. It is resolved from the project directory */ public final static String DEFAULT_DIR = "."; /** the default file name: TESTS-TestSuites.xml */ @@ -307,8 +307,8 @@ public class XMLResultAggregator extends Task implements XMLConstants { /** * Create a new document builder. Will issue an ExceptionInitializerError * if something is going wrong. It is fatal anyway. + * To-do: factorize this somewhere else. It is duplicated code. * @return a new document builder to create a DOM - * @todo factorize this somewhere else. It is duplicated code. */ private static DocumentBuilder getDocumentBuilder() { try { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/Xalan1Executor.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/Xalan1Executor.java index 97aeb9b48..f678a4c06 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/Xalan1Executor.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/Xalan1Executor.java @@ -63,7 +63,7 @@ import org.apache.xalan.xslt.XSLTResultTarget; /** * Xalan 1 executor. It will need a lot of things in the classpath: * xerces for the serialization, xalan and bsf for the extension. - * @todo do everything via reflection to avoid compile problems ? + * To-do: do everything via reflection to avoid compile problems ? */ public class Xalan1Executor extends XalanExecutor { void execute() throws Exception { diff --git a/src/main/org/apache/tools/ant/types/CommandlineJava.java b/src/main/org/apache/tools/ant/types/CommandlineJava.java index b7cdab370..0014f651d 100644 --- a/src/main/org/apache/tools/ant/types/CommandlineJava.java +++ b/src/main/org/apache/tools/ant/types/CommandlineJava.java @@ -64,9 +64,9 @@ import org.apache.tools.ant.taskdefs.condition.Os; /** * A representation of a Java command line that is nothing more - * than a composite of 2 Commandline. 1 for the vm/options and - * 1 for the classname/arguments. It provides specific methods for - * a java command line. + * than a composite of 2 Commandline. One is used for the + * vm/options and one for the classname/arguments. It provides + * specific methods for a java command line. * * @author thomas.haas@softwired-inc.com * @author Stephane Bailliez diff --git a/src/main/org/apache/tools/ant/types/FilterSet.java b/src/main/org/apache/tools/ant/types/FilterSet.java index df597d3e9..f57c59858 100644 --- a/src/main/org/apache/tools/ant/types/FilterSet.java +++ b/src/main/org/apache/tools/ant/types/FilterSet.java @@ -75,7 +75,6 @@ import org.apache.tools.ant.Project; * A filter set may have begintoken and endtokens defined. * * @author Michael McCallum - * @created 14 March 2001 */ public class FilterSet extends DataType implements Cloneable { @@ -83,7 +82,6 @@ public class FilterSet extends DataType implements Cloneable { * Individual filter component of filterset * * @author Michael McCallum - * @created 14 March 2001 */ public static class Filter { /** Token which will be replaced in the filter operation */ @@ -150,7 +148,6 @@ public class FilterSet extends DataType implements Cloneable { * The filtersfile nested element. * * @author Michael McCallum - * @created Thursday, April 19, 2001 */ public class FiltersFile { diff --git a/src/main/org/apache/tools/ant/types/RegularExpression.java b/src/main/org/apache/tools/ant/types/RegularExpression.java index 807748e23..64be97e21 100644 --- a/src/main/org/apache/tools/ant/types/RegularExpression.java +++ b/src/main/org/apache/tools/ant/types/RegularExpression.java @@ -87,7 +87,7 @@ import org.apache.tools.ant.util.regexp.RegexpFactory; * /> * * - * @see org.apache.oro.regex.Perl5Compiler + * @see org.apache.oro.text.regex.Perl5Compiler * @see org.apache.regexp.RE * @see java.util.regex.Pattern * diff --git a/src/main/org/apache/tools/ant/types/Substitution.java b/src/main/org/apache/tools/ant/types/Substitution.java index ed1be516c..7c80c33f7 100644 --- a/src/main/org/apache/tools/ant/types/Substitution.java +++ b/src/main/org/apache/tools/ant/types/Substitution.java @@ -68,7 +68,7 @@ import org.apache.tools.ant.types.DataType; * /> * * - * @see org.apache.oro.text.regex.Perl5Substitition + * @see org.apache.oro.text.regex.Perl5Substitution * @author Matthew Inger mattinger@mindless.com */ public class Substitution extends DataType diff --git a/src/main/org/apache/tools/ant/util/PackageNameMapper.java b/src/main/org/apache/tools/ant/util/PackageNameMapper.java index cd1cb590d..019086466 100644 --- a/src/main/org/apache/tools/ant/util/PackageNameMapper.java +++ b/src/main/org/apache/tools/ant/util/PackageNameMapper.java @@ -65,7 +65,6 @@ import java.io.File; * * *@author Erik Hatcher - *@created December 29, 2001 */ public class PackageNameMapper extends GlobPatternMapper { /** diff --git a/src/main/org/apache/tools/ant/util/regexp/RegexpFactory.java b/src/main/org/apache/tools/ant/util/regexp/RegexpFactory.java index b5d34e935..4d27ecac3 100644 --- a/src/main/org/apache/tools/ant/util/regexp/RegexpFactory.java +++ b/src/main/org/apache/tools/ant/util/regexp/RegexpFactory.java @@ -112,11 +112,12 @@ public class RegexpFactory extends RegexpMatcherFactory } /** - * Wrapper over {@seee RegexpMatcherFactory#createInstance - * createInstance} that ensures that we are dealing with a Regexp - * implementation. + * Wrapper over RegexpMatcherFactory.createInstance that ensures that + * we are dealing with a Regexp implementation. * * @since 1.3 + * + * @see RegexpMatcherFactory#createInstance(String) */ protected Regexp createRegexpInstance(String classname) throws BuildException {