ehatcher 2002/06/22 16:40:24
Modified: src/main/org/apache/tools/ant/taskdefs/optional Tag:
ANT_15_BRANCH ANTLR.java IContract.java Javah.java
src/main/org/apache/tools/ant/taskdefs/optional/sitraka Tag:
ANT_15_BRANCH Coverage.java CovMerge.java
CovReport.java
src/main/org/apache/tools/ant/taskdefs/optional/ejb Tag:
ANT_15_BRANCH Ejbc.java IPlanetEjbc.java
IPlanetEjbcTask.java
src/main/org/apache/tools/ant/taskdefs/optional/dotnet Tag:
ANT_15_BRANCH Ilasm.java
src/main/org/apache/tools/ant/taskdefs Tag: ANT_15_BRANCH
Jar.java Java.java Transform.java
src/main/org/apache/tools/ant/taskdefs/optional/extension
Tag: ANT_15_BRANCH JarLibAvailableTask.java
JarLibDisplayTask.java JarLibManifestTask.java
JarLibResolveTask.java
src/main/org/apache/tools/ant/taskdefs/optional/javacc Tag:
ANT_15_BRANCH JavaCC.java JJTree.java
src/main/org/apache/tools/ant/taskdefs/optional/jdepend Tag:
ANT_15_BRANCH JDependTask.java
src/main/org/apache/tools/ant/taskdefs/optional/jlink Tag:
ANT_15_BRANCH JlinkTask.java
src/main/org/apache/tools/ant/taskdefs/optional/jsp Tag:
ANT_15_BRANCH JspC.java
src/main/org/apache/tools/ant/taskdefs/optional/junit Tag:
ANT_15_BRANCH JUnitTask.java
src/main/org/apache/tools/ant/taskdefs/optional/ide Tag:
ANT_15_BRANCH VAJLoadProjects.java
Log:
last big batch of javadoc fixups from me. a few small ones left.
Revision Changes Path
No revision
No revision
1.10.2.3 +28 -19
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ANTLR.java
Index: ANTLR.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ANTLR.java,v
retrieving revision 1.10.2.2
retrieving revision 1.10.2.3
diff -u -r1.10.2.2 -r1.10.2.3
--- ANTLR.java 21 Jun 2002 15:30:45 -0000 1.10.2.2
+++ ANTLR.java 22 Jun 2002 23:40:21 -0000 1.10.2.3
@@ -121,32 +121,38 @@
commandline.setClassname("antlr.Tool");
}
+ /**
+ * The grammar file to process.
+ */
public void setTarget(File target) {
log("Setting target to: " + target.toString(), Project.MSG_VERBOSE);
this.target = target;
}
+ /**
+ * The directory to write the generated files to.
+ */
public void setOutputdirectory(File outputDirectory) {
log("Setting output directory to: " + outputDirectory.toString(),
Project.MSG_VERBOSE);
this.outputDirectory = outputDirectory;
}
/**
- * Sets an optional super grammar file
+ * Sets an optional super grammar file.
*/
public void setGlib(String superGrammar) {
this.superGrammar = superGrammar;
}
-
+
/**
* Sets a flag to enable ParseView debugging
*/
public void setDebug(boolean enable) {
debug = enable;
}
-
+
/**
- * Sets a flag to emit html
+ * If true, emit html
*/
public void setHtml(boolean enable) {
html = enable;
@@ -158,43 +164,46 @@
public void setDiagnostic(boolean enable) {
diagnostic = enable;
}
-
+
/**
- * Sets a flag to enable all tracing
+ * If true, enables all tracing.
*/
public void setTrace(boolean enable) {
trace = enable;
}
-
+
/**
- * Sets a flag to enable parser tracing
+ * If true, enables parser tracing.
*/
public void setTraceParser(boolean enable) {
traceParser = enable;
}
-
+
/**
- * Sets a flag to allow the user to enable lexer tracing
+ * If true, enables lexer tracing.
*/
public void setTraceLexer(boolean enable) {
traceLexer = enable;
}
-
+
/**
* Sets a flag to allow the user to enable tree walker tracing
*/
public void setTraceTreeWalker(boolean enable) {
traceTreeWalker = enable;
}
-
+
// we are forced to fork ANTLR since there is a call
// to System.exit() and there is nothing we can do
// right now to avoid this. :-( (SBa)
// I'm not removing this method to keep backward compatibility
+ /**
+ * @ant.attribute ignore="true"
+ */
public void setFork(boolean s) {
//this.fork = s;
}
-
+
/**
* The working directory of the process
*/
@@ -203,15 +212,15 @@
}
/**
- * <code><classpath></code> allows classpath to be set
- * because a directory might be given for Antlr debug...
+ * Adds a classpath to be set
+ * because a directory might be given for Antlr debug.
*/
public Path createClasspath() {
return commandline.createClasspath(project).createPath();
}
/**
- * Create a new JVM argument. Ignored if no JVM is forked.
+ * Adds a new JVM argument.
* @return create a new JVM argument so that any argument can be passed
to the JVM.
* @see #setFork(boolean)
*/
@@ -266,7 +275,7 @@
if (target.lastModified() > getGeneratedFile().lastModified()) {
populateAttributes();
commandline.createArgument().setValue(target.toString());
-
+
log(commandline.describeCommand(), Project.MSG_VERBOSE);
int err = run(commandline.getCommandline());
if (err == 1) {
@@ -312,12 +321,12 @@
if (target == null || !target.isFile()) {
throw new BuildException("Invalid target: " + target);
}
-
+
// validate the superGrammar file
if (superGrammar != null && !new File(superGrammar).isFile()) {
throw new BuildException("Invalid super grammar file: " +
superGrammar);
}
-
+
// if no output directory is specified, used the target's directory
if (outputDirectory == null) {
String fileName = target.toString();
1.9.2.1 +19 -26
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/IContract.java
Index: IContract.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/IContract.java,v
retrieving revision 1.9
retrieving revision 1.9.2.1
diff -u -r1.9 -r1.9.2.1
--- IContract.java 15 Apr 2002 14:56:30 -0000 1.9
+++ IContract.java 22 Jun 2002 23:40:21 -0000 1.9.2.1
@@ -77,12 +77,12 @@
import org.apache.tools.ant.types.Reference;
/**
- * Instruments Java classes with <a
href="http://www.reliable-systems.com/tools/";>iContract</a>
- * DBC preprocessor.
+ * Instruments Java classes with iContract DBC preprocessor.
* <br/>
* The task can generate a properties file for <a
href="http://hjem.sol.no/hellesoy/icontrol.html";>iControl</a>,
* a graphical user interface that lets you turn on/off assertions. iControl
generates a control file that you can refer to
* from this task using the controlfile attribute.
+ * iContract is at <a
href="http://www.reliable-systems.com/tools/";>http://www.reliable-systems.com/tools/</a>
* <p/>
* Thanks to Rainer Schmitz for enhancements and comments.
*
@@ -226,12 +226,6 @@
private static final String ICONTROL_PROPERTIES_HEADER =
" You might want to set classRoot to point to your normal
compilation class root directory.";
- private static final String ICONTROL_PROPERTIES_MESSAGE =
- "You should probably modify icontrol.properties' classRoot to where
comiled (uninstrumented) classes go.";
-
- /** \ on windows, / on linux/unix */
- private static final String ps = System.getProperty("path.separator");
-
/** compiler to use for instrumenation */
private String icCompiler = "javac";
@@ -274,9 +268,6 @@
/** The -q option */
private boolean quiet = false;
- /** Indicates whether or not to use internal compilation */
- private boolean internalcompilation = false;
-
/** The -m option */
private File controlFile = null;
@@ -305,9 +296,8 @@
/** Regular compilation class root */
private File classDir = null;
-
/**
- * Sets the source directory
+ * Sets the source directory.
*
* @param srcDir the source directory
*/
@@ -317,9 +307,9 @@
/**
- * Sets the class directory (uninstrumented classes)
+ * Sets the class directory (uninstrumented classes).
*
- * @param srcDir the source directory
+ * @param classDir the source directory
*/
public void setClassdir(File classDir) {
this.classDir = classDir;
@@ -327,7 +317,7 @@
/**
- * Sets the instrumentation directory
+ * Sets the instrumentation directory.
*
* @param instrumentDir the source directory
*/
@@ -340,7 +330,7 @@
/**
- * Sets the build directory for instrumented classes
+ * Sets the build directory for instrumented classes.
*
* @param buildDir the build directory
*/
@@ -350,7 +340,7 @@
/**
- * Sets the build directory for repository classes
+ * Sets the build directory for repository classes.
*
* @param repositoryDir the source directory
*/
@@ -363,9 +353,9 @@
/**
- * Sets the build directory for instrumented classes
+ * Sets the build directory for instrumented classes.
*
- * @param buildDir the build directory
+ * @param repBuildDir the build directory
*/
public void setRepbuilddir(File repBuildDir) {
this.repBuildDir = repBuildDir;
@@ -373,7 +363,7 @@
/**
- * Turns on/off precondition instrumentation
+ * Turns on/off precondition instrumentation.
*
* @param pre true turns it on
*/
@@ -384,7 +374,7 @@
/**
- * Turns on/off postcondition instrumentation
+ * Turns on/off postcondition instrumentation.
*
* @param post true turns it on
*/
@@ -395,7 +385,7 @@
/**
- * Turns on/off invariant instrumentation
+ * Turns on/off invariant instrumentation.
*
* @param invariant true turns it on
*/
@@ -406,7 +396,7 @@
/**
- * Sets the Throwable (Exception) to be thrown on assertion violation
+ * Sets the Throwable (Exception) to be thrown on assertion violation.
*
* @param clazz the fully qualified Throwable class name
*/
@@ -474,9 +464,12 @@
/**
- * Creates a nested classpath element
+ * Sets the classpath.
*
* @return the nested classpath element
+ * @todo this overwrites the classpath so only one
+ * effective classpath element would work. This
+ * is not how we do this elsewhere.
*/
public Path createClasspath() {
if (classpath == null) {
@@ -497,7 +490,7 @@
/**
- * Decides whether or not to update iControl properties file
+ * If true, updates iControl properties file
*
* @param updateIcontrol true if iControl properties file should be
* updated
1.15.2.1 +36 -9
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java
Index: Javah.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java,v
retrieving revision 1.15
retrieving revision 1.15.2.1
diff -u -r1.15 -r1.15.2.1
--- Javah.java 25 Apr 2002 12:14:50 -0000 1.15
+++ Javah.java 22 Jun 2002 23:40:21 -0000 1.15.2.1
@@ -71,8 +71,9 @@
import java.util.Enumeration;
/**
- * Task to generate JNI header files using javah. This task can take the
following
- * arguments:
+ * Generates JNI header files using javah.
+ *
+ * This task can take the following arguments:
* <ul>
* <li>classname - the fully-qualified name of a class</li>
* <li>outputFile - Concatenates the resulting header or source files for all
@@ -118,10 +119,16 @@
//private Path extdirs;
private static String lSep = System.getProperty("line.separator");
+ /**
+ * the fully-qualified name of the class (or classes, separated by
commas).
+ */
public void setClass(String cls) {
this.cls = cls;
}
+ /**
+ * Adds class to process.
+ */
public ClassArgument createClass() {
ClassArgument ga = new ClassArgument();
classes.addElement(ga);
@@ -152,6 +159,9 @@
this.destDir = destDir;
}
+ /**
+ * the classpath to use.
+ */
public void setClasspath(Path src) {
if (classpath == null) {
classpath = src;
@@ -159,6 +169,10 @@
classpath.append(src);
}
}
+
+ /**
+ * Path to use for classpath.
+ */
public Path createClasspath() {
if (classpath == null) {
classpath = new Path(project);
@@ -167,12 +181,16 @@
}
/**
- * Adds a reference to a CLASSPATH defined elsewhere.
+ * Adds a reference to a classpath defined elsewhere.
+ * @todo this needs to be documented in the HTML docs
*/
public void setClasspathRef(Reference r) {
createClasspath().setRefid(r);
}
+ /**
+ * location of bootstrap class files.
+ */
public void setBootclasspath(Path src) {
if (bootclasspath == null) {
bootclasspath = src;
@@ -180,6 +198,10 @@
bootclasspath.append(src);
}
}
+
+ /**
+ * Adds path to bootstrap class files.
+ */
public Path createBootclasspath() {
if (bootclasspath == null) {
bootclasspath = new Path(project);
@@ -188,7 +210,8 @@
}
/**
- * Adds a reference to a CLASSPATH defined elsewhere.
+ * Adds a reference to a classpath defined elsewhere.
+ * @todo this needs to be documented in the HTML
*/
public void setBootClasspathRef(Reference r) {
createBootclasspath().setRefid(r);
@@ -217,35 +240,39 @@
//}
/**
- * Set the output file name.
+ * Concatenates the resulting header or source files for all
+ * the classes listed into this file.
*/
public void setOutputFile(File outputFile) {
this.outputFile = outputFile;
}
/**
- * Set the force-write flag.
+ * If true, output files should always be written (JDK1.2 only).
*/
public void setForce(boolean force) {
this.force = force;
}
/**
- * Set the old flag.
+ * If true, specifies that old JDK1.0-style header files should be
+ * generated.
+ * (otherwise output file contain JNI-style native method function
prototypes) (JDK1.2 only)
*/
public void setOld(boolean old) {
this.old = old;
}
/**
- * Set the stubs flag.
+ * If true, generate C declarations from the Java object file (used with
old).
*/
public void setStubs(boolean stubs) {
this.stubs = stubs;
}
/**
- * Set the verbose flag.
+ * If true, causes Javah to print a message concerning
+ * the status of the generated files.
*/
public void setVerbose(boolean verbose) {
this.verbose = verbose;
No revision
No revision
1.10.2.1 +73 -12
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Coverage.java
Index: Coverage.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/Coverage.java,v
retrieving revision 1.10
retrieving revision 1.10.2.1
diff -u -r1.10 -r1.10.2.1
--- Coverage.java 25 Apr 2002 12:14:51 -0000 1.10
+++ Coverage.java 22 Jun 2002 23:40:22 -0000 1.10.2.1
@@ -75,7 +75,8 @@
import org.apache.tools.ant.types.Path;
/**
- * Convenient task to run Sitraka JProbe Coverage from Ant.
+ * Runs Sitraka JProbe Coverage.
+ *
* Options are pretty numerous, you'd better check the manual for a full
* descriptions of options. (not that simple since they differ from the
online
* help, from the usage command line and from the examples...)
@@ -131,7 +132,9 @@
//--------- setters used via reflection --
- /** set the coverage home directory where are libraries, jars and
jplauncher */
+ /**
+ * The directory where JProbe is installed.
+ */
public void setHome(File value) {
home = value;
}
@@ -141,10 +144,16 @@
seedName = value;
}
+ /**
+ * @ant.attribute ignore="true"
+ */
public void setInputfile(File value) {
inputFile = value;
}
+ /**
+ * Path to the java executable.
+ */
public void setJavaexe(File value) {
javaExe = value;
}
@@ -155,25 +164,43 @@
}
}
- /** jdk117, jdk118 or java2, can be null, default to java2 */
+ /**
+ * Indicates which virtual machine to run: "jdk117", "jdk118" or "java2".
+ * Can be null, default to "java2". */
public void setVm(Javavm value) {
vm = value.getValue();
}
- /** default to false unless file is htm or html */
+ /**
+ * If true, run an applet.
+ */
public void setApplet(boolean value) {
applet = value;
}
- /** always, error, never */
+ /**
+ * Toggles display of the console prompt: always, error, never
+ */
public void setExitprompt(String value) {
exitPrompt = value;
}
+ /**
+ * Defines class/method filters based on pattern matching.
+ * The syntax is filters is similar to a fileset.
+ */
public Filters createFilters() {
return filters;
}
+ /**
+ * Defines events to use for interacting with the
+ * collection of data performed during coverage.
+ *
+ * For example you may run a whole application but only decide
+ * to collect data once it reaches a certain method and once it
+ * exits another one.
+ */
public Triggers createTriggers() {
if (triggers == null) {
triggers = new Triggers();
@@ -181,6 +208,10 @@
return triggers;
}
+ /**
+ * Define a host and port to connect to if you want to do
+ * remote viewing.
+ */
public Socket createSocket() {
if (socket == null) {
socket = new Socket();
@@ -194,7 +225,10 @@
}
}
- /** none, coverage, all. Can be null, default to none */
+ /**
+ * Type of snapshot to send at program termination: none, coverage, all.
+ * Can be null, default to none
+ */
public void setFinalsnapshot(String value) {
finalSnapshot = value;
}
@@ -205,50 +239,77 @@
}
}
- /** all, coverage, none */
+ /**
+ * "all", "coverage", or "none".
+ */
public void setRecordfromstart(Recordfromstart value) {
recordFromStart = value.getValue();
}
+ /**
+ * Set warning level (0-3, where 0 is the least amount of warnings).
+ */
public void setWarnlevel(Integer value) {
warnLevel = value.intValue();
}
+ /**
+ * The path to the directory where snapshot files are stored.
+ * Choose a directory that is reachable by both the remote
+ * and local computers, and enter the same path on the command-line
+ * and in the viewer.
+ */
public void setSnapshotdir(File value) {
snapshotDir = value;
}
+ /**
+ * The physical path to the working directory for the VM.
+ */
public void setWorkingdir(File value) {
workingDir = value;
}
+ /**
+ * If true, track native methods.
+ */
public void setTracknatives(boolean value) {
trackNatives = value;
}
//
- /** the jvm arguments */
+ /**
+ * Adds a JVM argument.
+ */
public Commandline.Argument createJvmarg() {
return cmdlJava.createVmArgument();
}
- /** the command arguments */
+ /**
+ * Adds a command argument.
+ */
public Commandline.Argument createArg() {
return cmdlJava.createArgument();
}
- /** classpath to run the files */
+ /**
+ * classpath to run the files.
+ */
public Path createClasspath() {
return cmdlJava.createClasspath(project).createPath();
}
- /** classname to run as standalone or runner for filesets */
+ /**
+ * classname to run as standalone or runner for filesets.
+ */
public void setClassname(String value) {
cmdlJava.setClassname(value);
}
- /** the classnames to execute */
+ /**
+ * the classnames to execute.
+ */
public void addFileset(FileSet fs) {
filesets.addElement(fs);
}
1.10.2.1 +10 -7
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/CovMerge.java
Index: CovMerge.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/CovMerge.java,v
retrieving revision 1.10
retrieving revision 1.10.2.1
diff -u -r1.10 -r1.10.2.1
--- CovMerge.java 25 Apr 2002 12:14:51 -0000 1.10
+++ CovMerge.java 22 Jun 2002 23:40:22 -0000 1.10.2.1
@@ -71,10 +71,9 @@
import org.apache.tools.ant.types.FileSet;
/**
- * Convenient task to run the snapshot merge utility for JProbe Coverage.
+ * Runs the snapshot merge utility for JProbe Coverage.
*
* @author <a href="[EMAIL PROTECTED]">Stephane Bailliez</a>
- *
* @ant.task name="jpcovmerge" category="metrics"
*/
public class CovMerge extends Task {
@@ -91,26 +90,30 @@
private boolean verbose;
/**
- * set the coverage home. It must point to JProbe coverage
- * directories where are stored native librairies and jars
+ * The directory where JProbe is installed.
*/
public void setHome(File value) {
this.home = value;
}
/**
- * Set the output snapshot file
+ * Set the output snapshot file.
*/
public void setTofile(File value) {
this.tofile = value;
}
- /** run the merging in verbose mode */
+ /**
+ * If true, perform the merge in verbose mode giving details
+ * about the snapshot processing.
+ */
public void setVerbose(boolean flag) {
this.verbose = flag;
}
- /** add a fileset containing the snapshots to include/exclude */
+ /**
+ * add a fileset containing the snapshots to include.
+ */
public void addFileset(FileSet fs) {
filesets.addElement(fs);
}
1.11.2.1 +36 -11
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/CovReport.java
Index: CovReport.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/sitraka/CovReport.java,v
retrieving revision 1.11
retrieving revision 1.11.2.1
diff -u -r1.11 -r1.11.2.1
--- CovReport.java 25 Apr 2002 12:14:51 -0000 1.11
+++ CovReport.java 22 Jun 2002 23:40:22 -0000 1.11.2.1
@@ -78,10 +78,9 @@
/**
- * Convenient task to run the snapshot merge utility for JProbe Coverage 3.0.
+ * Runs the JProbe Coverage 3.0 snapshot merge utility.
*
* @author <a href="[EMAIL PROTECTED]">Stephane Bailliez</a>
- *
* @ant.task name="jpcovreport" category="metrics"
*/
public class CovReport extends Task {
@@ -167,8 +166,7 @@
/**
- * Set the coverage home. It must point to JProbe coverage
- * directories where are stored native libraries and jars.
+ * The directory where JProbe is installed.
*/
public void setHome(File value) {
this.home = value;
@@ -180,7 +178,9 @@
}
}
- /** set the format of the report html|text|xml*/
+ /**
+ * set the format of the report: "html", "text", or "xml"
+ */
public void setFormat(ReportFormat value) {
this.format = value.getValue();
}
@@ -191,26 +191,41 @@
}
}
- /** sets the report type executive|summary|detailed|verydetailed */
+ /**
+ * The type of report to be generated: "executive", "summary",
+ * "detailed" or "verydetailed".
+ */
public void setType(ReportType value) {
this.type = value.getValue();
}
- /** include source code lines. XML report only */
+ /**
+ * If true, include text of the source code lines.
+ * Only applies to format="xml" and type="verydetailed"
+ */
public void setIncludesource(boolean value) {
this.includeSource = value;
}
- /** sets the threshold printing method 0-100*/
+ /**
+ * A numeric value for the threshold for printing methods.
+ * Must be between 0 and 100.
+ */
public void setPercent(Integer value) {
this.percent = value;
}
- /** set the filters */
+ /**
+ * set the filters
+ * @ant.attribute ignore="true"
+ */
public void setFilters(String values) {
this.filters = values;
}
+ /**
+ * Adds a path to source files.
+ */
public Path createSourcepath() {
if (sourcePath == null) {
sourcePath = new Path(project);
@@ -218,18 +233,24 @@
return sourcePath.createPath();
}
+ /**
+ * The name of the snapshot file that is the source to the report.
+ */
public void setSnapshot(File value) {
this.snapshot = value;
}
/**
- * Set the output snapshot file
+ * The name of the generated output file.
*/
public void setTofile(File value) {
this.tofile = value;
}
- //@todo to remove
+ /**
+ * @todo needs to be removed
+ * @ant.element ignore="true"
+ */
public Path createCoveragepath() {
if (coveragePath == null) {
coveragePath = new Path(project);
@@ -237,6 +258,10 @@
return coveragePath.createPath();
}
+ /**
+ * Adds a set of classes whose coverage information will be
+ * checked against.
+ */
public Reference createReference() {
if (reference == null) {
reference = new Reference();
No revision
No revision
1.18.2.2 +5 -0
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/Ejbc.java
Index: Ejbc.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/Ejbc.java,v
retrieving revision 1.18.2.1
retrieving revision 1.18.2.2
diff -u -r1.18.2.1 -r1.18.2.2
--- Ejbc.java 20 Jun 2002 00:35:46 -0000 1.18.2.1
+++ Ejbc.java 22 Jun 2002 23:40:22 -0000 1.18.2.2
@@ -184,6 +184,11 @@
generatedFilesDirectory = new File(dirName);
}
+ /**
+ * If true, ejbc will keep the
+ * intermediate Java files used to build the class files.
+ * This can be useful when debugging.
+ */
public void setKeepgenerated(String newKeepgenerated) {
keepgenerated =
Boolean.valueOf(newKeepgenerated.trim()).booleanValue();
1.9.2.2 +12 -9
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java
Index: IPlanetEjbc.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java,v
retrieving revision 1.9.2.1
retrieving revision 1.9.2.2
diff -u -r1.9.2.1 -r1.9.2.2
--- IPlanetEjbc.java 14 Jun 2002 14:56:09 -0000 1.9.2.1
+++ IPlanetEjbc.java 22 Jun 2002 23:40:22 -0000 1.9.2.2
@@ -80,7 +80,7 @@
import org.xml.sax.AttributeList;
/**
- * Utility class to compile EJB stubs and skeletons for the iPlanet
Application
+ * Compiles EJB stubs and skeletons for the iPlanet Application
* Server (iAS). The class will read a standard EJB descriptor (as well as
an
* EJB descriptor specific to iPlanet Application Server) to identify one or
* more EJBs to process. It will search for EJB "source" classes (the remote
@@ -102,6 +102,7 @@
* @see IPlanetDeploymentTool
* @see IPlanetEjbcTask
* @author Greg Nelson <a href="mailto:[EMAIL PROTECTED]">[EMAIL
PROTECTED]</a>
+ * @ant.task ignore="true"
*/
public class IPlanetEjbc {
@@ -160,6 +161,8 @@
* by the iAS ejbc utility.
* @param parser SAXParser to be used to process both of the EJB
* descriptors.
+ * @todo classpathElements is not needed here, its never used
+ * (at least IDEA tells me so! :)
*/
public IPlanetEjbc(File stdDescriptor,
File iasDescriptor,
@@ -189,19 +192,19 @@
}
/**
- * Sets whether or not the Java source files which are generated by the
- * ejbc process should be retained or automatically deleted.
+ * If true, the Java source files which are generated by the
+ * ejbc process are retained.
*
- * @param retainsource A boolean indicating if the Java source files for
+ * @param retainSource A boolean indicating if the Java source files for
* the stubs and skeletons should be retained.
+ * @todo This is not documented in the HTML. On purpose?
*/
public void setRetainSource(boolean retainSource) {
this.retainSource = retainSource;
}
/**
- * Sets whether or not debugging output will be generated when ejbc is
- * executed.
+ * If true, enables debugging output when ejbc is executed.
*
* @param debugOutput A boolean indicating if debugging output should be
* generated
@@ -224,11 +227,11 @@
}
/**
- * Setter method used to store the "home" directory of the user's iAS
- * installation. The directory specified should typically be
+ * May be used to specify the "home" directory for this iAS installation.
+ * The directory specified should typically be
* <code>[install-location]/iplanet/ias6/ias</code>.
*
- * @param iashome The home directory for the user's iAS installation.
+ * @param iasHomeDir The home directory for the user's iAS installation.
*/
public void setIasHomeDir(File iasHomeDir) {
this.iasHomeDir = iasHomeDir;
1.6.2.1 +7 -8
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbcTask.java
Index: IPlanetEjbcTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbcTask.java,v
retrieving revision 1.6
retrieving revision 1.6.2.1
diff -u -r1.6 -r1.6.2.1
--- IPlanetEjbcTask.java 15 Apr 2002 13:36:19 -0000 1.6
+++ IPlanetEjbcTask.java 22 Jun 2002 23:40:22 -0000 1.6.2.1
@@ -67,7 +67,7 @@
import org.apache.tools.ant.BuildException;
/**
- * Task to compile EJB stubs and skeletons for the iPlanet Application
Server.
+ * Compiles EJB stubs and skeletons for the iPlanet Application Server.
* The EJBs to be processed are specified by the EJB 1.1 standard XML
* descriptor, and additional attributes are obtained from the iPlanet
Application
* Server-specific XML descriptor. Since the XML descriptors can include
@@ -156,7 +156,7 @@
}
/**
- * Sets the destination directory where the EJB "source" classes must
exist
+ * Sets the destination directory where the EJB source classes must exist
* and where the stubs and skeletons will be written. The destination
* directory must exist before this task is executed.
*
@@ -180,7 +180,7 @@
}
/**
- * Creates a nested classpath element.
+ * Adds to the classpath used when compiling the EJB stubs and skeletons.
*/
public Path createClasspath() {
if (classpath == null) {
@@ -190,8 +190,7 @@
}
/**
- * Sets whether or not the Java source files which are generated by the
- * ejbc process should be retained or automatically deleted.
+ * If true, the Java source files which are generated by ejbc will be
saved .
*
* @param keepgenerated A boolean indicating if the Java source files for
* the stubs and skeletons should be retained.
@@ -201,7 +200,7 @@
}
/**
- * Sets whether or not debugging output will be generated when ejbc is
+ * If true, debugging output will be generated when ejbc is
* executed.
*
* @param debug A boolean indicating if debugging output should be
generated
@@ -211,8 +210,8 @@
}
/**
- * Setter method used to store the "home" directory of the user's iAS
- * installation. The directory specified should typically be
+ * May be used to specify the "home" directory for this iAS installation.
+ * The directory specified should typically be
* <code>[install-location]/iplanet/ias6/ias</code>.
*
* @param iashome The home directory for the user's iAS installation.
No revision
No revision
1.18.2.1 +18 -18
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/Ilasm.java
Index: Ilasm.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/Ilasm.java,v
retrieving revision 1.18
retrieving revision 1.18.2.1
diff -u -r1.18 -r1.18.2.1
--- Ilasm.java 15 Apr 2002 14:56:31 -0000 1.18
+++ Ilasm.java 22 Jun 2002 23:40:22 -0000 1.18.2.1
@@ -78,7 +78,7 @@
import org.apache.tools.ant.taskdefs.MatchingTask;
/**
- * Task to assemble .net 'Intermediate Language' files. The task will only
work
+ * Assembles .NET Intermediate Language files. The task will only work
* on win2K until other platforms support csc.exe or an equivalent.
ilasm.exe
* must be on the execute path too. <p>
*
@@ -207,9 +207,9 @@
/**
- * Set the source dir to find the files to be compiled
+ * Set the source directory containing the files to be compiled.
*
- [EMAIL PROTECTED] srcDirName The new SrcDir value
+ * @param srcDirName The new SrcDir value
*/
public void setSrcDir(File srcDirName) {
srcDir = srcDirName;
@@ -217,13 +217,12 @@
/**
- * define the target
+ * Sets the type of target, either "exe" or "library".
*
[EMAIL PROTECTED] targetType one of exe|library|
[EMAIL PROTECTED] BuildException if target is not one of
- * exe|library|module|winexe
+ * exe|library
*/
-
public void setTargetType(String targetType)
throws BuildException {
this.targetType = targetType.toLowerCase();
@@ -266,11 +265,11 @@
/**
- * Sets the Owner attribute
+ * Sets the Owner attribute.
*
- [EMAIL PROTECTED] s The new Owner value
+ * @param s The new Owner value
+ * @ant.attribute ignore="true"
*/
-
public void setOwner(String s) {
log("This option is not supported by ILASM as of Beta-2, and will be
ignored", Project.MSG_WARN);
}
@@ -288,7 +287,7 @@
/**
- * enable/disable verbose ILASM output
+ * If true, enable verbose ILASM output.
*
[EMAIL PROTECTED] b flag set to true for verbose on
*/
@@ -308,7 +307,7 @@
/**
- * enable/disable listing
+ * If true, produce a listing (off by default).
*
[EMAIL PROTECTED] b flag set to true for listing on
*/
@@ -328,7 +327,7 @@
/**
- * Set the output file
+ * Set the output file.
*
[EMAIL PROTECTED] params The new outputFile value
*/
@@ -352,9 +351,9 @@
/**
- * Set the resource file
+ * name of resource file to include.
*
- [EMAIL PROTECTED] fileName path to the file. Can be relative,
absolute, whatever.
+ * @param fileName path to the file. Can be relative, absolute,
whatever.
*/
public void setResourceFile(File fileName) {
resourceFile = fileName;
@@ -376,7 +375,7 @@
/**
- * set fail on error flag
+ * If true, fails if ilasm tool fails.
*
[EMAIL PROTECTED] b The new failOnError value
*/
@@ -396,7 +395,7 @@
/**
- * set the debug flag on or off
+ * set the debug flag on or off.
*
[EMAIL PROTECTED] f on/off flag
*/
@@ -426,7 +425,7 @@
/**
- * Sets the keyfile attribute of the Ilasm object
+ * the name of a file containing a private key.
*
[EMAIL PROTECTED] keyfile The new keyfile value
*/
@@ -450,7 +449,8 @@
/**
- * Sets the ExtraOptions attribute
+ * Any extra options which are not explicitly
+ * supported by this task.
*
[EMAIL PROTECTED] extraOptions The new ExtraOptions value
*/
No revision
No revision
1.51.2.8 +1 -3
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Jar.java
Index: Jar.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Jar.java,v
retrieving revision 1.51.2.7
retrieving revision 1.51.2.8
diff -u -r1.51.2.7 -r1.51.2.8
--- Jar.java 21 Jun 2002 06:49:36 -0000 1.51.2.7
+++ Jar.java 22 Jun 2002 23:40:22 -0000 1.51.2.8
@@ -137,9 +137,7 @@
}
/**
- * Not supported.
- *
- * @param we
+ * @ant.attribute ignore="true"
*/
public void setWhenempty(WhenEmpty we) {
log("JARs are never empty, they contain at least a manifest file",
1.45.2.2 +2 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Java.java
Index: Java.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Java.java,v
retrieving revision 1.45.2.1
retrieving revision 1.45.2.2
diff -u -r1.45.2.1 -r1.45.2.2
--- Java.java 19 Jun 2002 04:23:19 -0000 1.45.2.1
+++ Java.java 22 Jun 2002 23:40:22 -0000 1.45.2.2
@@ -72,7 +72,7 @@
import java.util.Vector;
/**
- * This task acts as a loader for java applications but allows to use
+ * Launcher for Java applications. Allows use of
* the same JVM for the called application thus resulting in much
* faster operation.
*
@@ -231,6 +231,7 @@
/**
* Deprecated: use nested arg instead.
* Set the command line arguments for the class.
+ * @ant.attribute ignore="true"
*/
public void setArgs(String s) {
log("The args attribute is deprecated. " +
1.9.2.1 +2 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Transform.java
Index: Transform.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Transform.java,v
retrieving revision 1.9
retrieving revision 1.9.2.1
diff -u -r1.9 -r1.9.2.1
--- Transform.java 12 Apr 2002 13:26:50 -0000 1.9
+++ Transform.java 22 Jun 2002 23:40:22 -0000 1.9.2.1
@@ -57,6 +57,7 @@
/**
* Has been merged into ExecuteOn, empty class for backwards compatibility.
*
- * @author <a href="mailto:[EMAIL PROTECTED]">Stefan Bodewig</a>
+ * @author <a href="mailto:[EMAIL PROTECTED]">Stefan Bodewig</a>
+ * @ant.task ignore="true"
*/
public class Transform extends ExecuteOn {}
No revision
No revision
1.1.2.2 +2 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibAvailableTask.java
Index: JarLibAvailableTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibAvailableTask.java,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- JarLibAvailableTask.java 2 Jun 2002 11:04:46 -0000 1.1.2.1
+++ JarLibAvailableTask.java 22 Jun 2002 23:40:22 -0000 1.1.2.2
@@ -91,7 +91,7 @@
private ExtensionAdapter m_extension;
/**
- * The name of property to set if extensions is available.
+ * The name of property to set if extensions are available.
*
* @param property The name of property to set if extensions is
available.
*/
@@ -101,7 +101,7 @@
}
/**
- * The jar library to check.
+ * The JAR library to check.
*
* @param file The jar library to check.
*/
1.1.2.1 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibDisplayTask.java
Index: JarLibDisplayTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibDisplayTask.java,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- JarLibDisplayTask.java 22 Apr 2002 13:33:37 -0000 1.1
+++ JarLibDisplayTask.java 22 Jun 2002 23:40:22 -0000 1.1.2.1
@@ -90,7 +90,7 @@
private final Vector m_filesets = new Vector();
/**
- * The jar library to display information for.
+ * The JAR library to display information for.
*
* @param file The jar library to display information for.
*/
1.1.2.1 +2 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibManifestTask.java
Index: JarLibManifestTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibManifestTask.java,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- JarLibManifestTask.java 30 Apr 2002 07:57:19 -0000 1.1
+++ JarLibManifestTask.java 22 Jun 2002 23:40:22 -0000 1.1.2.1
@@ -65,8 +65,8 @@
import org.apache.tools.ant.Project;
/**
- * Task to generate a manifest that declares all the dependencies
- * in manifest. The dependencies are determined by looking in the
+ * Generates a manifest that declares all the dependencies.
+ * The dependencies are determined by looking in the
* specified path and searching for Extension / "Optional Package"
* specifications in the manifests of the jars.
*
1.2.2.3 +20 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibResolveTask.java
Index: JarLibResolveTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibResolveTask.java,v
retrieving revision 1.2.2.2
retrieving revision 1.2.2.3
diff -u -r1.2.2.2 -r1.2.2.3
--- JarLibResolveTask.java 1 May 2002 11:53:43 -0000 1.2.2.2
+++ JarLibResolveTask.java 22 Jun 2002 23:40:22 -0000 1.2.2.3
@@ -64,12 +64,12 @@
import
org.apache.tools.ant.taskdefs.optional.extension.resolvers.AntResolver;
/**
- * Try to locate a jar to satisfy an extension and place
+ * Tries to locate a JAR to satisfy an extension and place
* location of jar into property.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Peter Donald</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Jeff Turner</a>
- * @ant.task name="jarlib-resolver"
+ * @ant.task name="jarlib-resolve"
*/
public class JarLibResolveTask
extends Task
@@ -117,26 +117,44 @@
m_property = property;
}
+ /**
+ * If true, libraries returned by nested resolvers should be
+ * checked to see if they supply extension.
+ */
public void setCheckExtension( final boolean checkExtension )
{
m_checkExtension = checkExtension;
}
+ /**
+ * If true, failure to locate library should fail build.
+ */
public void setFailOnError( final boolean failOnError )
{
m_failOnError = failOnError;
}
+ /**
+ * Adds location resolver to look for a library in a location
+ * relative to project directory.
+ */
public void addConfiguredLocation( final LocationResolver location )
{
m_resolvers.add( location );
}
+ /**
+ * Adds a URL resolveer to download a library from a URL
+ * to a local file.
+ */
public void addConfiguredUrl( final URLResolver url )
{
m_resolvers.add( url );
}
+ /**
+ * Adds Ant resolver to run an Ant build file to generate a library.
+ */
public void addConfiguredAnt( final AntResolver ant )
{
m_resolvers.add( ant );
No revision
No revision
1.16.2.1 +72 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JavaCC.java
Index: JavaCC.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JavaCC.java,v
retrieving revision 1.16
retrieving revision 1.16.2.1
diff -u -r1.16 -r1.16.2.1
--- JavaCC.java 15 Apr 2002 14:56:32 -0000 1.16
+++ JavaCC.java 22 Jun 2002 23:40:23 -0000 1.16.2.1
@@ -69,7 +69,7 @@
import java.util.Enumeration;
/**
- * Taskdef for the JavaCC compiler compiler.
+ * JavaCC compiler compiler task.
*
* @author [EMAIL PROTECTED]
* @author Michael Saunders <a href="mailto:[EMAIL PROTECTED]">[EMAIL
PROTECTED]</a>
@@ -109,94 +109,165 @@
private CommandlineJava cmdl = new CommandlineJava();
+ /**
+ * Sets the LOOKAHEAD grammar option.
+ */
public void setLookahead(int lookahead) {
optionalAttrs.put(LOOKAHEAD, new Integer(lookahead));
}
+ /**
+ * Sets the CHOICE_AMBIGUITY_CHECK grammar option.
+ */
public void setChoiceambiguitycheck(int choiceAmbiguityCheck) {
optionalAttrs.put(CHOICE_AMBIGUITY_CHECK, new
Integer(choiceAmbiguityCheck));
}
+ /**
+ * Sets the OTHER_AMBIGUITY_CHECK grammar option.
+ */
public void setOtherambiguityCheck(int otherAmbiguityCheck) {
optionalAttrs.put(OTHER_AMBIGUITY_CHECK, new
Integer(otherAmbiguityCheck));
}
+ /**
+ * Sets the STATIC grammar option.
+ */
public void setStatic(boolean staticParser) {
optionalAttrs.put(STATIC, new Boolean(staticParser));
}
+ /**
+ * Sets the DEBUG_PARSER grammar option.
+ */
public void setDebugparser(boolean debugParser) {
optionalAttrs.put(DEBUG_PARSER, new Boolean(debugParser));
}
+ /**
+ * Sets the DEBUG_LOOKAHEAD grammar option.
+ */
public void setDebuglookahead(boolean debugLookahead) {
optionalAttrs.put(DEBUG_LOOKAHEAD, new Boolean(debugLookahead));
}
+ /**
+ * Sets the DEBUG_TOKEN_MANAGER grammar option.
+ */
public void setDebugtokenmanager(boolean debugTokenManager) {
optionalAttrs.put(DEBUG_TOKEN_MANAGER, new
Boolean(debugTokenManager));
}
+ /**
+ * Sets the OPTIMIZE_TOKEN_MANAGER grammar option.
+ */
public void setOptimizetokenmanager(boolean optimizeTokenManager) {
optionalAttrs.put(OPTIMIZE_TOKEN_MANAGER, new
Boolean(optimizeTokenManager));
}
+ /**
+ * Sets the ERROR_REPORTING grammar option.
+ */
public void setErrorreporting(boolean errorReporting) {
optionalAttrs.put(ERROR_REPORTING, new Boolean(errorReporting));
}
+ /**
+ * Sets the JAVA_UNICODE_ESCAPE grammar option.
+ */
public void setJavaunicodeescape(boolean javaUnicodeEscape) {
optionalAttrs.put(JAVA_UNICODE_ESCAPE, new
Boolean(javaUnicodeEscape));
}
+ /**
+ * Sets the UNICODE_INPUT grammar option.
+ */
public void setUnicodeinput(boolean unicodeInput) {
optionalAttrs.put(UNICODE_INPUT, new Boolean(unicodeInput));
}
+ /**
+ * Sets the IGNORE_CASE grammar option.
+ */
public void setIgnorecase(boolean ignoreCase) {
optionalAttrs.put(IGNORE_CASE, new Boolean(ignoreCase));
}
+ /**
+ * Sets the COMMON_TOKEN_ACTION grammar option.
+ */
public void setCommontokenaction(boolean commonTokenAction) {
optionalAttrs.put(COMMON_TOKEN_ACTION, new
Boolean(commonTokenAction));
}
+ /**
+ * Sets the USER_TOKEN_MANAGER grammar option.
+ */
public void setUsertokenmanager(boolean userTokenManager) {
optionalAttrs.put(USER_TOKEN_MANAGER, new Boolean(userTokenManager));
}
+ /**
+ * Sets the USER_CHAR_STREAM grammar option.
+ */
public void setUsercharstream(boolean userCharStream) {
optionalAttrs.put(USER_CHAR_STREAM, new Boolean(userCharStream));
}
+ /**
+ * Sets the BUILD_PARSER grammar option.
+ */
public void setBuildparser(boolean buildParser) {
optionalAttrs.put(BUILD_PARSER, new Boolean(buildParser));
}
+ /**
+ * Sets the BUILD_TOKEN_MANAGER grammar option.
+ */
public void setBuildtokenmanager(boolean buildTokenManager) {
optionalAttrs.put(BUILD_TOKEN_MANAGER, new
Boolean(buildTokenManager));
}
+ /**
+ * Sets the SANITY_CHECK grammar option.
+ */
public void setSanitycheck(boolean sanityCheck) {
optionalAttrs.put(SANITY_CHECK, new Boolean(sanityCheck));
}
+ /**
+ * Sets the FORCE_LA_CHECK grammar option.
+ */
public void setForcelacheck(boolean forceLACheck) {
optionalAttrs.put(FORCE_LA_CHECK, new Boolean(forceLACheck));
}
+ /**
+ * Sets the CACHE_TOKENS grammar option.
+ */
public void setCachetokens(boolean cacheTokens) {
optionalAttrs.put(CACHE_TOKENS, new Boolean(cacheTokens));
}
+ /**
+ * The directory to write the generated files to.
+ * If not set, the files are written to the directory
+ * containing the grammar file.
+ */
public void setOutputdirectory(File outputDirectory) {
this.outputDirectory = outputDirectory;
}
+ /**
+ * The grammar file to process.
+ */
public void setTarget(File target) {
this.target = target;
}
+ /**
+ * The directory containing the JavaCC distribution.
+ */
public void setJavacchome(File javaccHome) {
this.javaccHome = javaccHome;
}
1.13.2.1 +45 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java
Index: JJTree.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java,v
retrieving revision 1.13
retrieving revision 1.13.2.1
diff -u -r1.13 -r1.13.2.1
--- JJTree.java 25 Apr 2002 12:14:50 -0000 1.13
+++ JJTree.java 22 Jun 2002 23:40:23 -0000 1.13.2.1
@@ -69,7 +69,7 @@
import java.util.Enumeration;
/**
- * Taskdef for the JJTree compiler compiler.
+ * Runs the JJTree compiler compiler.
*
* @author [EMAIL PROTECTED]
* @author Michael Saunders <a href="mailto:[EMAIL PROTECTED]">[EMAIL
PROTECTED]</a>
@@ -100,58 +100,102 @@
private CommandlineJava cmdl = new CommandlineJava();
+ /**
+ * Sets the BUILD_NODE_FILES grammar option.
+ */
public void setBuildnodefiles(boolean buildNodeFiles) {
optionalAttrs.put(BUILD_NODE_FILES, new Boolean(buildNodeFiles));
}
+ /**
+ * Sets the MULTI grammar option.
+ */
public void setMulti(boolean multi) {
optionalAttrs.put(MULTI, new Boolean(multi));
}
+ /**
+ * Sets the NODE_DEFAULT_VOID grammar option.
+ */
public void setNodedefaultvoid(boolean nodeDefaultVoid) {
optionalAttrs.put(NODE_DEFAULT_VOID, new Boolean(nodeDefaultVoid));
}
+ /**
+ * Sets the NODE_FACTORY grammar option.
+ */
public void setNodefactory(boolean nodeFactory) {
optionalAttrs.put(NODE_FACTORY, new Boolean(nodeFactory));
}
+ /**
+ * Sets the NODE_SCOPE_HOOK grammar option.
+ */
public void setNodescopehook(boolean nodeScopeHook) {
optionalAttrs.put(NODE_SCOPE_HOOK, new Boolean(nodeScopeHook));
}
+ /**
+ * Sets the NODE_USES_PARSER grammar option.
+ */
public void setNodeusesparser(boolean nodeUsesParser) {
optionalAttrs.put(NODE_USES_PARSER, new Boolean(nodeUsesParser));
}
+ /**
+ * Sets the STATIC grammar option.
+ */
public void setStatic(boolean staticParser) {
optionalAttrs.put(STATIC, new Boolean(staticParser));
}
+ /**
+ * Sets the VISITOR grammar option.
+ */
public void setVisitor(boolean visitor) {
optionalAttrs.put(VISITOR, new Boolean(visitor));
}
+ /**
+ * Sets the NODE_PACKAGE grammar option.
+ */
public void setNodepackage(String nodePackage) {
optionalAttrs.put(NODE_PACKAGE, new String(nodePackage));
}
+ /**
+ * Sets the VISITOR_EXCEPTION grammar option.
+ */
public void setVisitorException(String visitorException) {
optionalAttrs.put(VISITOR_EXCEPTION, new String(visitorException));
}
+ /**
+ * Sets the NODE_PREFIX grammar option.
+ */
public void setNodeprefix(String nodePrefix) {
optionalAttrs.put(NODE_PREFIX, new String(nodePrefix));
}
+ /**
+ * The directory to write the generated file to.
+ * If not set, the files are written to the directory
+ * containing the grammar file.
+ */
public void setOutputdirectory(File outputDirectory) {
this.outputDirectory = outputDirectory;
}
+ /**
+ * The jjtree grammar file to process.
+ */
public void setTarget(File target) {
this.target = target;
}
+ /**
+ * The directory containing the JavaCC distribution.
+ */
public void setJavacchome(File javaccHome) {
this.javaccHome = javaccHome;
}
No revision
No revision
1.12.2.1 +19 -6
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java
Index: JDependTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java,v
retrieving revision 1.12
retrieving revision 1.12.2.1
diff -u -r1.12 -r1.12.2.1
--- JDependTask.java 25 Apr 2002 12:14:50 -0000 1.12
+++ JDependTask.java 22 Jun 2002 23:40:23 -0000 1.12.2.1
@@ -74,7 +74,7 @@
import org.apache.tools.ant.types.EnumeratedAttribute;
/**
- * Ant task to run JDepend tests.
+ * Runs JDepend tests.
*
* <p>JDepend is a tool to generate design quality metrics for each Java
package.
* It has been initially created by Mike Clark. JDepend can be found at <a
@@ -116,6 +116,11 @@
}
*/
+ /**
+ * The output file name.
+ *
+ * @param outputFile
+ */
public void setOutputFile(File outputFile) {
_outputFile = outputFile;
}
@@ -136,7 +141,8 @@
}
/**
- * Tells whether a JVM should be forked for the task. Default: false.
+ * If true, forks into a new JVM. Default: false.
+ *
* @param value <tt>true</tt> if a JVM should be forked, otherwise
<tt>false<tt>
*/
public void setFork(boolean value) {
@@ -148,7 +154,9 @@
}
/**
- * Set a new VM to execute the task. Default is <tt>java</tt>. Ignored
if no JVM is forked.
+ * The command used to invoke a forked Java Virtual Machine.
+ *
+ * Default is <tt>java</tt>. Ignored if no JVM is forked.
* @param value the new VM to use instead of <tt>java</tt>
* @see #setFork(boolean)
*/
@@ -158,7 +166,7 @@
}
/**
- * Maybe creates a nested classpath element.
+ * Adds a path to source code to analyze.
*/
public Path createSourcespath() {
if (_sourcesPath == null) {
@@ -202,7 +210,7 @@
}
/**
- * Maybe creates a nested classpath element.
+ * Adds a path to the classpath.
*/
public Path createClasspath() {
if (_compileClasspath == null) {
@@ -221,13 +229,18 @@
}
/**
- * Adds a reference to a CLASSPATH defined elsewhere.
+ * Adds a reference to a classpath defined elsewhere.
*/
public void setClasspathRef(Reference r) {
createClasspath().setRefid(r);
}
+ /**
+ * The format to write the output in, "xml" or "text".
+ *
+ * @param ea
+ */
public void setFormat(FormatAttribute ea) {
format = ea.getValue();
}
No revision
No revision
1.8.2.1 +3 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.java
Index: JlinkTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.java,v
retrieving revision 1.8
retrieving revision 1.8.2.1
diff -u -r1.8 -r1.8.2.1
--- JlinkTask.java 15 Apr 2002 13:36:20 -0000 1.8
+++ JlinkTask.java 22 Jun 2002 23:40:23 -0000 1.8.2.1
@@ -85,7 +85,9 @@
* </pre>
* </code>
*
- * @author <a href="mailto:[EMAIL PROTECTED]">Matthew Kuperus Heun</a> */
+ * @author <a href="mailto:[EMAIL PROTECTED]">Matthew Kuperus Heun</a>
+ * @ant.task ignore="true"
+ */
public class JlinkTask extends MatchingTask {
/**
No revision
No revision
1.16.2.3 +36 -21
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java
Index: JspC.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java,v
retrieving revision 1.16.2.2
retrieving revision 1.16.2.3
diff -u -r1.16.2.2 -r1.16.2.3
--- JspC.java 6 Jun 2002 06:24:12 -0000 1.16.2.2
+++ JspC.java 22 Jun 2002 23:40:23 -0000 1.16.2.3
@@ -71,7 +71,9 @@
import org.apache.tools.ant.types.Path;
import org.apache.tools.ant.types.Reference;
-/** Ant task to run the jsp compiler.
+/**
+ * Runs a JSP compiler.
+ *
* <p> This task takes the given jsp files and compiles them into java
* files. It is then up to the user to compile the java files into classes.
*
@@ -164,7 +166,7 @@
= "Compile failed, messages should have been provided.";
/* ------------------------------------------------------------ */
/**
- * Set the source dirs to find the source JSP files.
+ * Path for source JSP files.
*/
public void setSrcdir(Path srcDir) {
if (src == null) {
@@ -188,12 +190,14 @@
return destDir;
}
/* ------------------------------------------------------------ */
+
/**
- * Set the name of the package the compiled jsp files should be in
+ * Set the name of the package the compiled jsp files should be in.
*/
public void setPackage(String pkg){
this.packageName = pkg;
}
+
public String getPackage(){
return packageName;
}
@@ -226,7 +230,9 @@
public String getIeplugin() {
return iepluginid;
}
- /** Set the ieplugin id */
+ /**
+ * Java Plugin CLASSID for Internet Explorer
+ */
public void setIeplugin(String iepluginid_) {
iepluginid = iepluginid_;
}
@@ -234,16 +240,18 @@
public boolean isMapped() {
return mapped;
}
- /** set the mapped flag */
+ /**
+ * If true, generate separate write() calls for each HTML line
+ * in the JSP.
+ */
public void setMapped(boolean mapped_) {
mapped = mapped_;
}
/**
- * The -uribase option. The uri context of relative URI
- * references in the JSP pages. If it does not
- * exist then it is derived from the location of the file
- * relative to the declared or derived value of -uriroot.
+ * The URI context of relative URI references in the JSP pages.
+ * If it does not exist then it is derived from the location
+ * of the file relative to the declared or derived value of uriroot.
*
* @param uribase The new Uribase value
*/
@@ -256,9 +264,8 @@
}
/**
- * The -uriroot option.
- * <p>The root directory that uri files should be resolved
- * against, (Default is the directory jspc is invoked from)
+ * The root directory that uri files should be resolved
+ * against. (Default is the directory jspc is invoked from)
*
* @param uriroot The new Uribase value
*/
@@ -272,7 +279,9 @@
/* ------------------------------------------------------------ */
- /** Set the classpath to be used for this compilation */
+ /**
+ * Set the classpath to be used for this compilation.
+ */
public void setClasspath(Path cp) {
if (classpath == null) {
classpath = cp;
@@ -280,14 +289,20 @@
classpath.append(cp);
}
}
- /** Maybe creates a nested classpath element. */
+
+ /**
+ * Adds a path to the classpath.
+ */
public Path createClasspath() {
if (classpath == null) {
classpath = new Path(project);
}
return classpath.createPath();
}
- /** Adds a reference to a CLASSPATH defined elsewhere */
+
+ /**
+ * Adds a reference to a classpath defined elsewhere
+ */
public void setClasspathRef(Reference r) {
createClasspath().setRefid(r);
}
@@ -296,7 +311,7 @@
}
/**
- * -webxml <file> Creates a complete web.xml when using the
-webapp option.
+ * Filename for web.xml.
*
* @param webxml The new Webxml value
*/
@@ -309,8 +324,8 @@
}
/**
- * name output file for the fraction of web.xml that lists
- * servlets
+ * output filename for the fraction of web.xml that lists
+ * servlets.
* @param webinc The new Webinc value
*/
public void setWebinc(File webinc) {
@@ -322,9 +337,9 @@
}
/**
- * Web apps parameter. Only one is allowed.
+ * Adds a single webapp.
*
- * @param fs add a web app fileset
+ * @param webappParam add a web app parameter
*/
public void addWebApp(WebAppParameter webappParam)
throws BuildException {
@@ -341,7 +356,7 @@
}
/**
- * Sets the compiler to use. Optional: default=jasper
+ * Class name of a JSP compiler adapter.
*/
public void setCompiler(String compiler) {
this.compilerName = compiler;
No revision
No revision
1.44.2.1 +34 -27
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java
Index: JUnitTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java,v
retrieving revision 1.44
retrieving revision 1.44.2.1
diff -u -r1.44 -r1.44.2.1
--- JUnitTask.java 25 Apr 2002 12:14:50 -0000 1.44
+++ JUnitTask.java 22 Jun 2002 23:40:23 -0000 1.44.2.1
@@ -82,7 +82,7 @@
import java.net.URL;
/**
- * Ant task to run JUnit tests.
+ * Runs JUnit tests.
*
* <p> JUnit is a framework to create unit test. It has been initially
* created by Erich Gamma and Kent Beck. JUnit can be found at <a
@@ -175,8 +175,8 @@
private boolean showOutput = false;
/**
- * Tells this task whether to smartly filter the stack frames of
- * JUnit testcase errors and failures before reporting them.
+ * If true, smartly filter the stack frames of
+ * JUnit errors and failures before reporting them.
*
* <p>This property is applied on all BatchTest (batchtest) and
* JUnitTest (test) however it can possibly be overridden by their
@@ -195,8 +195,8 @@
}
/**
- * Tells this task to halt when there is an error in a test. this
- * property is applied on all BatchTest (batchtest) and JUnitTest
+ * If true, stop the build process when there is an error in a test.
+ * This property is applied on all BatchTest (batchtest) and JUnitTest
* (test) however it can possibly be overridden by their own
* properties.
* @param value <tt>true</tt> if it should halt, otherwise
@@ -213,8 +213,7 @@
}
/**
- * Tells this task to set the named property to "true" when there
- * is a error in a test.
+ * Property to set to "true" if there is a error in a test.
*
* <p>This property is applied on all BatchTest (batchtest) and
* JUnitTest (test), however, it can possibly be overriden by
@@ -233,8 +232,9 @@
}
/**
- * Tells this task to halt when there is a failure in a test.
- * this property is applied on all BatchTest (batchtest) and
+ * If true, stop the build process if a test fails
+ * (errors are considered failures as well).
+ * This property is applied on all BatchTest (batchtest) and
* JUnitTest (test) however it can possibly be overridden by their
* own properties.
* @param value <tt>true</tt> if it should halt, otherwise
@@ -251,8 +251,7 @@
}
/**
- * Tells this task to set the named property to "true" when there
- * is a failure in a test.
+ * Property to set to "true" if there is a failure in a test.
*
* <p>This property is applied on all BatchTest (batchtest) and
* JUnitTest (test), however, it can possibly be overriden by
@@ -271,7 +270,7 @@
}
/**
- * Tells whether a JVM should be forked for each testcase.
+ * If true, JVM should be forked for each test.
*
* <p>It avoids interference between testcases and possibly avoids
* hanging the build. this property is applied on all BatchTest
@@ -292,8 +291,10 @@
}
/**
- * Tells whether the task should print a short summary of the
- * task.
+ * If true, print one-line statistics for each test, or "withOutAndErr"
+ * to also show standard output and error.
+ *
+ * Can take the values on, off, and withOutAndErr.
* @param value <tt>true</tt> to print a summary,
* <tt>withOutAndErr</tt> to include the test's output as
* well, <tt>false</tt> otherwise.
@@ -351,8 +352,10 @@
}
/**
- * Set a new VM to execute the testcase. Default is
- * <tt>java</tt>. Ignored if no JVM is forked.
+ * The command used to invoke the Java Virtual Machine,
+ * default is 'java'. The command is resolved by
+ * java.lang.Runtime.exec(). Ignored if fork is disabled.
+ *
* @param value the new VM to use instead of <tt>java</tt>
* @see #setFork(boolean)
*
@@ -363,7 +366,8 @@
}
/**
- * Create a new JVM argument. Ignored if no JVM is forked.
+ * Adds a JVM argument; ignored if not forking.
+ *
* @return create a new JVM argument so that any argument can be
* passed to the JVM.
* @see #setFork(boolean)
@@ -386,8 +390,9 @@
}
/**
- * Add a nested sysproperty element. This might be useful to tranfer
- * Ant properties to the testcases when JVM forking is not enabled.
+ * Adds a system property that tests can access.
+ * This might be useful to tranfer Ant properties to the
+ * testcases when JVM forking is not enabled.
*
* @since Ant 1.3
*/
@@ -396,7 +401,7 @@
}
/**
- * <code><classpath></code> allows classpath to be set for tests.
+ * Adds path to classpath used for tests.
*
* @since Ant 1.2
*/
@@ -405,7 +410,7 @@
}
/**
- * Add a nested env element - an environment variable.
+ * Adds an environment variable; used when forking.
*
* <p>Will be ignored if we are not forking a new VM.</p>
*
@@ -416,7 +421,7 @@
}
/**
- * Use a completely new environment.
+ * If true, use a new environment when forked.
*
* <p>Will be ignored if we are not forking a new VM.</p>
*
@@ -438,8 +443,8 @@
}
/**
- * Create a new set of testcases (also called ..batchtest) and add
- * it to the list.
+ * Adds a set of tests based on pattern matching.
+ *
* @return a new instance of a batch test.
* @see BatchTest
*
@@ -461,7 +466,7 @@
}
/**
- * Whether to include ant.jar, optional.jar and junit.jar in the forked
VM.
+ * If true, include ant.jar, optional.jar and junit.jar in the forked VM.
*
* @since Ant 1.5
*/
@@ -470,7 +475,9 @@
}
/**
- * Whether to send output of the testcases to Ant's logging system or
not.
+ * If true, send any output generated by tests to Ant's logging system
+ * as well as to the formatters.
+ * By default only the formatters receive the output.
*
* <p>Output will always be passed to the formatters and not by
* shown by default. This option should for example be set for
No revision
No revision
1.10.2.1 +1 -0
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ide/VAJLoadProjects.java
Index: VAJLoadProjects.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/ide/VAJLoadProjects.java,v
retrieving revision 1.10
retrieving revision 1.10.2.1
diff -u -r1.10 -r1.10.2.1
--- VAJLoadProjects.java 12 Apr 2002 13:44:36 -0000 1.10
+++ VAJLoadProjects.java 22 Jun 2002 23:40:23 -0000 1.10.2.1
@@ -67,6 +67,7 @@
* and will be removed soon
*
* @author Wolf Siberski, TUI Infotec GmbH
+ * @ant.task ignore="true"
*/
public class VAJLoadProjects extends VAJLoad {
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
