conor 02/04/16 00:15:19
Modified: . check.xml
src/main/org/apache/tools/ant/filters StringInputStream.java
src/main/org/apache/tools/ant/taskdefs AbstractCvsTask.java
Ant.java AntStructure.java CVSPass.java Copy.java
Ear.java
src/main/org/apache/tools/ant/taskdefs/compilers
DefaultCompilerAdapter.java Javac12.java
Javac13.java Jvc.java Kjc.java
src/main/org/apache/tools/ant/taskdefs/optional/ejb
Ejbc.java
src/main/org/apache/tools/ant/types Path.java
RegularExpression.java Substitution.java
src/main/org/apache/tools/tar TarOutputStream.java
Log:
Some simple Javadocs - also reduce scope of Javadoc work to public
for now
Revision Changes Path
1.3 +4 -2 jakarta-ant/check.xml
Index: check.xml
===================================================================
RCS file: /home/cvs/jakarta-ant/check.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -w -u -r1.2 -r1.3
--- check.xml 9 Apr 2002 14:19:32 -0000 1.2
+++ check.xml 16 Apr 2002 07:15:18 -0000 1.3
@@ -1,13 +1,15 @@
<project default="checkstyle" name="CheckAnt">
<property name="java.dir" value="src/main"/>
<property name="tocheck" value="**/*.java"/>
+ <property name="javadoc.scope" value="public"/>
<target name="checkstyle">
<taskdef name="checkstyle"
classname="com.puppycrawl.tools.checkstyle.CheckStyleTask"/>
<checkstyle headerFile="src/etc/RequiredHeader.txt"
headerIgnoreLine="4"
- allowProtected="true">
+ allowProtected="true"
+ javadocScope="${javadoc.scope}">
<fileset dir="${java.dir}">
<include name="${tocheck}"/>
</fileset>
1.5 +1 -1
jakarta-ant/src/main/org/apache/tools/ant/filters/StringInputStream.java
Index: StringInputStream.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/filters/StringInputStream.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -w -u -r1.4 -r1.5
--- StringInputStream.java 15 Apr 2002 13:36:16 -0000 1.4
+++ StringInputStream.java 16 Apr 2002 07:15:18 -0000 1.5
@@ -100,7 +100,7 @@
}
/**
- * Resetthe StringReader
+ * Reset the StringReader.
*/
public synchronized void reset() throws IOException {
in.reset();
1.11 +6 -6
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java
Index: AbstractCvsTask.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -w -u -r1.10 -r1.11
1.54 +3 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Ant.java
Index: Ant.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Ant.java,v
retrieving revision 1.53
retrieving revision 1.54
diff -u -w -u -r1.53 -r1.54
--- Ant.java 15 Apr 2002 15:33:08 -0000 1.53
+++ Ant.java 16 Apr 2002 07:15:18 -0000 1.54
@@ -535,7 +535,9 @@
public static class Reference
extends org.apache.tools.ant.types.Reference {
- public Reference() {super();}
+ public Reference() {
+ super();
+ }
private String targetid = null;
1.25 +6 -2
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/AntStructure.java
Index: AntStructure.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/AntStructure.java,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -w -u -r1.24 -r1.25
--- AntStructure.java 12 Apr 2002 14:46:44 -0000 1.24
+++ AntStructure.java 16 Apr 2002 07:15:18 -0000 1.25
@@ -77,13 +77,12 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]">Stefan Bodewig</a>
*
- * @version $Revision: 1.24 $
+ * @version $Revision: 1.25 $
*
* @since Ant 1.1
*
* @ant.task category="xml"
*/
-
public class AntStructure extends Task {
private final String lSep = System.getProperty("line.separator");
@@ -103,6 +102,11 @@
this.output = output;
}
+ /**
+ * Build the antstructure DTD.
+ *
+ * @exception BuildException if the DTD cannot be written.
+ */
public void execute() throws BuildException {
if (output == null) {
1.13 +4 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/CVSPass.java
Index: CVSPass.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/CVSPass.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -w -u -r1.12 -r1.13
--- CVSPass.java 12 Apr 2002 14:46:44 -0000 1.12
+++ CVSPass.java 16 Apr 2002 07:15:18 -0000 1.13
@@ -72,7 +72,7 @@
* Adds an new entry to a CVS password file
*
* @author <a href="[EMAIL PROTECTED]">Jeff Martin</a>
- * @version $Revision: 1.12 $
+ * @version $Revision: 1.13 $
*
* @since Ant 1.4
*
@@ -106,6 +106,9 @@
243, 233, 253, 240, 194, 250, 191, 155, 142, 137, 245, 235, 163,
242, 178, 152
};
+ /**
+ * Create a CVS task using the default cvspass file location.
+ */
public CVSPass(){
passFile = new File(System.getProperty("user.home") + "/.cvspass");
}
1.42 +4 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Copy.java
Index: Copy.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Copy.java,v
retrieving revision 1.41
retrieving revision 1.42
diff -u -w -u -r1.41 -r1.42
--- Copy.java 15 Apr 2002 15:33:08 -0000 1.41
+++ Copy.java 16 Apr 2002 07:15:18 -0000 1.42
@@ -91,7 +91,7 @@
* @author <A href="[EMAIL PROTECTED]">Michael McCallum</A>
* @author <a href="mailto:[EMAIL PROTECTED]">Magesh Umasankar</a>
*
- * @version $Revision: 1.41 $
+ * @version $Revision: 1.42 $
*
* @since Ant 1.2
*
@@ -121,6 +121,9 @@
private FileUtils fileUtils;
private String encoding = null;
+ /**
+ * Copy task constructor.
+ */
public Copy() {
fileUtils = FileUtils.newFileUtils();
}
1.15 +3 -0
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Ear.java
Index: Ear.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Ear.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -w -u -r1.14 -r1.15
--- Ear.java 15 Apr 2002 13:36:17 -0000 1.14
+++ Ear.java 16 Apr 2002 07:15:18 -0000 1.15
@@ -76,6 +76,9 @@
private File deploymentDescriptor;
private boolean descriptorAdded;
+ /**
+ * Create an Ear task.
+ */
public Ear() {
super();
archiveType = "ear";
1.25 +11 -0
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.java
Index: DefaultCompilerAdapter.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.java,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -w -u -r1.24 -r1.25
--- DefaultCompilerAdapter.java 15 Apr 2002 15:33:10 -0000 1.24
+++ DefaultCompilerAdapter.java 16 Apr 2002 07:15:18 -0000 1.25
@@ -114,6 +114,12 @@
private FileUtils fileUtils = FileUtils.newFileUtils();
+ /**
+ * Set the Javac instance which contains the configured compilation
+ * attributes.
+ *
+ * @param attributes a configured Javac task.
+ */
public void setJavac(Javac attributes) {
this.attributes = attributes;
src = attributes.getSrcdir();
@@ -138,6 +144,11 @@
memoryMaximumSize = attributes.getMemoryMaximumSize();
}
+ /**
+ * Get the Javac task instance associated with this compiler adapter
+ *
+ * @return the configured Javac task instance used by this adapter.
+ */
public Javac getJavac() {
return attributes;
}
1.9 +5 -0
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/compilers/Javac12.java
Index: Javac12.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/compilers/Javac12.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -w -u -r1.8 -r1.9
--- Javac12.java 15 Apr 2002 15:33:11 -0000 1.8
+++ Javac12.java 16 Apr 2002 07:15:18 -0000 1.9
@@ -79,6 +79,11 @@
*/
public class Javac12 extends DefaultCompilerAdapter {
+ /**
+ * Run the compilation.
+ *
+ * @exception BuildException if the compilation has problems.
+ */
public boolean execute() throws BuildException {
attributes.log("Using classic compiler", Project.MSG_VERBOSE);
Commandline cmd = setupJavacCommand(true);
1.9 +5 -0
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/compilers/Javac13.java
Index: Javac13.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/compilers/Javac13.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -w -u -r1.8 -r1.9
--- Javac13.java 15 Apr 2002 15:33:11 -0000 1.8
+++ Javac13.java 16 Apr 2002 07:15:18 -0000 1.9
@@ -82,6 +82,11 @@
*/
private static final int MODERN_COMPILER_SUCCESS = 0;
+ /**
+ * Run the compilation.
+ *
+ * @exception BuildException if the compilation has problems.
+ */
public boolean execute() throws BuildException {
attributes.log("Using modern compiler", Project.MSG_VERBOSE);
Commandline cmd = setupModernJavacCommand();
1.9 +5 -0
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/compilers/Jvc.java
Index: Jvc.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/compilers/Jvc.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -w -u -r1.8 -r1.9
--- Jvc.java 15 Apr 2002 15:33:11 -0000 1.8
+++ Jvc.java 16 Apr 2002 07:15:18 -0000 1.9
@@ -73,6 +73,11 @@
*/
public class Jvc extends DefaultCompilerAdapter {
+ /**
+ * Run the compilation.
+ *
+ * @exception BuildException if the compilation has problems.
+ */
public boolean execute() throws BuildException {
attributes.log("Using jvc compiler", Project.MSG_VERBOSE);
1.9 +5 -0
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/compilers/Kjc.java
Index: Kjc.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/compilers/Kjc.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -w -u -r1.8 -r1.9
--- Kjc.java 15 Apr 2002 13:36:18 -0000 1.8
+++ Kjc.java 16 Apr 2002 07:15:18 -0000 1.9
@@ -74,6 +74,11 @@
*/
public class Kjc extends DefaultCompilerAdapter {
+ /**
+ * Run the compilation.
+ *
+ * @exception BuildException if the compilation has problems.
+ */
public boolean execute() throws BuildException {
attributes.log("Using kjc compiler", Project.MSG_VERBOSE);
Commandline cmd = setupKjcCommand();
1.17 +1 -1
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.16
retrieving revision 1.17
diff -u -w -u -r1.16 -r1.17
--- Ejbc.java 14 Apr 2002 11:16:18 -0000 1.16
+++ Ejbc.java 16 Apr 2002 07:15:18 -0000 1.17
@@ -65,7 +65,7 @@
/**
* Build EJB support classes using Weblogic's ejbc tool from a directory
containing
* a set of deployment descriptors.
-
+ *
*
* @author Conor MacNeill, Cortex ebusiness Pty Limited
*/
1.36 +1 -0 jakarta-ant/src/main/org/apache/tools/ant/types/Path.java
Index: Path.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/types/Path.java,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -w -u -r1.35 -r1.36
--- Path.java 15 Apr 2002 13:36:21 -0000 1.35
+++ Path.java 16 Apr 2002 07:15:18 -0000 1.36
@@ -100,6 +100,7 @@
private Vector elements;
+ /** The system classspath as a Path object */
public static Path systemClasspath =
new Path(null, System.getProperty("java.class.path"));
1.12 +1 -0
jakarta-ant/src/main/org/apache/tools/ant/types/RegularExpression.java
Index: RegularExpression.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/types/RegularExpression.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -w -u -r1.11 -r1.12
--- RegularExpression.java 15 Apr 2002 14:56:34 -0000 1.11
+++ RegularExpression.java 16 Apr 2002 07:15:18 -0000 1.12
@@ -97,6 +97,7 @@
* @ant.datatype name="regexp"
*/
public class RegularExpression extends DataType {
+ /** Name of this data type */
public static final String DATA_TYPE_NAME = "regexp";
// The regular expression factory
1.11 +1 -0
jakarta-ant/src/main/org/apache/tools/ant/types/Substitution.java
Index: Substitution.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/types/Substitution.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -w -u -r1.10 -r1.11
--- Substitution.java 15 Apr 2002 14:56:34 -0000 1.10
+++ Substitution.java 16 Apr 2002 07:15:18 -0000 1.11
@@ -71,6 +71,7 @@
* @author Matthew Inger <a href="mailto:[EMAIL PROTECTED]">[EMAIL
PROTECTED]</a>
*/
public class Substitution extends DataType {
+ /** The name of this data type */
public static final String DATA_TYPE_NAME = "substitition";
private String expression;
1.9 +5 -0
jakarta-ant/src/main/org/apache/tools/tar/TarOutputStream.java
Index: TarOutputStream.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/tar/TarOutputStream.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -w -u -r1.8 -r1.9
--- TarOutputStream.java 15 Apr 2002 14:56:34 -0000 1.8
+++ TarOutputStream.java 16 Apr 2002 07:15:19 -0000 1.9
@@ -71,8 +71,13 @@
* @author Timothy Gerard Endres <a href="mailto:[EMAIL PROTECTED]">[EMAIL
PROTECTED]</a>
*/
public class TarOutputStream extends FilterOutputStream {
+ /** Fail if a long file name is required in the archive. */
public static final int LONGFILE_ERROR = 0;
+
+ /** Long paths will be truncated in the archive. */
public static final int LONGFILE_TRUNCATE = 1;
+
+ /** GNU tar extensions are used to store long file names in the archive.
*/
public static final int LONGFILE_GNU = 2;
protected boolean debug;
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
