ehatcher 2002/06/19 13:48:00
Modified: src/main/org/apache/tools/ant/taskdefs/optional/dotnet Tag:
ANT_15_BRANCH CSharp.java
Log:
Javadoc cleanup. Steve - could you have a look at this? There are some
setters here that are not in the HTML docs, destdir for example.
Revision Changes Path
No revision
No revision
1.23.2.3 +37 -28
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java
Index: CSharp.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/dotnet/CSharp.java,v
retrieving revision 1.23.2.2
retrieving revision 1.23.2.3
diff -u -r1.23.2.2 -r1.23.2.3
--- CSharp.java 14 May 2002 05:04:49 -0000 1.23.2.2
+++ CSharp.java 19 Jun 2002 20:47:59 -0000 1.23.2.3
@@ -78,9 +78,10 @@
// ====================================================================
/**
- * This task compiles CSharp source into executables or modules. The task
will
- * only work on win2K until other platforms support csc.exe or an
equivalent.
- * CSC.exe must be on the execute path too. <p>
+ * Compiles C# source into executables or modules.
+ *
+ * The task will only work on win2K until other platforms support
+ * csc.exe or an equivalent. CSC.exe must be on the execute path too. <p>
*
* All parameters are optional: <csc/> should suffice to produce a
debug
* build of all *.cs files. References to external files do require explicit
@@ -354,7 +355,7 @@
/**
- * Set the reference list to be used for this compilation.
+ * Semicolon separated list of DLLs to refer to.
*
[EMAIL PROTECTED] s The new References value
*/
@@ -378,7 +379,8 @@
}
/**
- * add another path to the reference file path list
+ * Path of references to include.
+ * Wildcards should work.
*
[EMAIL PROTECTED] path another path to append
*/
@@ -434,6 +436,9 @@
/**
+ * If true, automatically includes the common assemblies
+ * in dotnet, and tells the compiler to link in mscore.dll.
+ *
* set the automatic reference inclusion flag on or off this flag
controls
* the string of references and the /nostdlib option in CSC
*
@@ -466,7 +471,7 @@
/**
- * set the optimise flag on or off
+ * If true, enables optimization flag.
*
[EMAIL PROTECTED] f on/off flag
*/
@@ -496,7 +501,7 @@
/**
- * set the incremental compilation flag on or off
+ * set the incremental compilation flag on or off.
*
[EMAIL PROTECTED] f on/off flag
*/
@@ -526,7 +531,7 @@
/**
- * set the debug flag on or off
+ * set the debug flag on or off.
*
[EMAIL PROTECTED] f on/off flag
*/
@@ -581,7 +586,8 @@
/**
- * set warn level (no range checking)
+ * Level of warning currently between 1 and 4
+ * with 4 being the strictest.
*
[EMAIL PROTECTED] warnLevel warn level -see .net docs for valid range
(probably
* 0-4)
@@ -612,7 +618,7 @@
/**
- * Sets the Unsafe attribute
+ * If true, enables the unsafe keyword.
*
[EMAIL PROTECTED] unsafe The new Unsafe value
*/
@@ -642,7 +648,7 @@
/**
- * Sets the MainClass attribute
+ * Sets the name of main class for executables.
*
[EMAIL PROTECTED] mainClass The new MainClass value
*/
@@ -676,7 +682,8 @@
/**
- * Sets the ExtraOptions attribute
+ * Any extra options which are not explicitly supported
+ * by this task.
*
[EMAIL PROTECTED] extraOptions The new ExtraOptions value
*/
@@ -710,7 +717,7 @@
/**
- * Set the source dir to find the files to be compiled
+ * Set the source directory of the files to be compiled.
*
[EMAIL PROTECTED] srcDirName The new SrcDir value
*/
@@ -720,7 +727,7 @@
/**
- * Set the destination dir to find the files to be compiled
+ * Set the destination directory of files to be compiled.
*
[EMAIL PROTECTED] dirName The new DestDir value
*/
@@ -730,9 +737,9 @@
/**
- * define the target
+ * Set the type of target.
*
- [EMAIL PROTECTED] targetType The new TargetType value
+ [EMAIL PROTECTED] ttype The new TargetType value
[EMAIL PROTECTED] BuildException if target is not one of
* exe|library|module|winexe
*/
@@ -774,7 +781,7 @@
/**
- * Set the win32 icon
+ * Set the filename of icon to include.
*
[EMAIL PROTECTED] fileName path to the file. Can be relative,
absolute, whatever.
*/
@@ -798,7 +805,8 @@
/**
- * Set the win32 resource
+ * Sets the filename of a win32 resource (.RES) file to include.
+ * This is not a .NET resource, but what Windows is used to.
*
[EMAIL PROTECTED] fileName path to the file. Can be relative,
absolute, whatever.
*/
@@ -822,7 +830,7 @@
/**
- * enable generation of utf8 output from the compiler.
+ * If true, require all compiler output to be in UTF8 format.
*
[EMAIL PROTECTED] enabled The new utf8Output value
*/
@@ -862,7 +870,7 @@
/**
- * Sets the fullPaths attribute of the CSharp object
+ * If true, print the full path of files on errors.
*
[EMAIL PROTECTED] enabled The new fullPaths value
*/
@@ -882,7 +890,7 @@
/**
- * Set the definitions
+ * Semicolon separated list of defined constants.
*
[EMAIL PROTECTED] params The new definitions value
*/
@@ -906,7 +914,7 @@
/**
- * Set the definitions
+ * Semicolon separated list of modules to refer to.
*
[EMAIL PROTECTED] params The new additionalModules value
*/
@@ -939,9 +947,9 @@
}
/**
- * Set the output file
+ * Set the name of exe/library to create.
*
- [EMAIL PROTECTED] params The new outputFile value
+ [EMAIL PROTECTED] file The new outputFile value
*/
public void setDestFile(File file) {
outputFile = file;
@@ -964,7 +972,7 @@
/**
- * set fail on error flag
+ * If true, fail on compilation errors.
*
[EMAIL PROTECTED] b The new FailOnError value
*/
@@ -982,9 +990,10 @@
return failOnError;
}
- /** set the file alignment.
- * Valid values are 0,512, 1024, 2048, 4096, 8192, and 16384
- * 0 means 'leave to the compiler'
+ /**
+ * Set the file alignment.
+ * Valid values are 0,512, 1024, 2048, 4096, 8192,
+ * and 16384, 0 means 'leave to the compiler'
*/
public void setFileAlign(int fileAlign) {
this.fileAlign = fileAlign;
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
