ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ehatc...@apache.org
Subject cvs commit: jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/dotnet CSharp.java
Date Wed, 19 Jun 2002 20:48:00 GMT
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: &lt;csc/&gt; 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.
        *
        *@param  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.
        *
        *@param  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.
        *
        *@param  f  on/off flag
        */
  @@ -496,7 +501,7 @@
   
   
       /**
  -     *  set the incremental compilation flag on or off
  +     *  set the incremental compilation flag on or off.
        *
        *@param  f  on/off flag
        */
  @@ -526,7 +531,7 @@
   
   
       /**
  -     *  set the debug flag on or off
  +     *  set the debug flag on or off.
        *
        *@param  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.
        *
        *@param  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.
        *
        *@param  unsafe  The new Unsafe value
        */
  @@ -642,7 +648,7 @@
   
   
       /**
  -     *  Sets the MainClass attribute
  +     *  Sets the name of main class for executables.
        *
        *@param  mainClass  The new MainClass value
        */
  @@ -676,7 +682,8 @@
   
   
       /**
  -     *  Sets the ExtraOptions attribute
  +     * Any extra options which are not explicitly supported
  +     * by this task.
        *
        *@param  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.
        *
        *@param  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.
        *
        *@param  dirName  The new DestDir value
        */
  @@ -730,9 +737,9 @@
   
   
       /**
  -     *  define the target
  +     * Set the type of target.
        *
  -     *@param  targetType          The new TargetType value
  +     *@param  ttype          The new TargetType value
        *@exception  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.
        *
        *@param  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.
        *
        *@param  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.
        *
        *@param  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.
        *
        *@param  enabled  The new fullPaths value
        */
  @@ -882,7 +890,7 @@
   
   
       /**
  -     *  Set the definitions
  +     *  Semicolon separated list of defined constants.
        *
        *@param  params  The new definitions value
        */
  @@ -906,7 +914,7 @@
   
   
       /**
  -     *  Set the definitions
  +     * Semicolon separated list of modules to refer to.
        *
        *@param  params  The new additionalModules value
        */
  @@ -939,9 +947,9 @@
       }
   
       /**
  -     *  Set the output file
  +     *  Set the name of exe/library to create.
        *
  -     *@param  params  The new outputFile value
  +     *@param  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.
        *
        *@param  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:ant-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:ant-dev-help@jakarta.apache.org>


Mime
View raw message