ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ste...@apache.org
Subject cvs commit: jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional StyleBook.java Test.java
Date Sun, 23 Jun 2002 22:45:55 GMT
stevel      2002/06/23 15:45:55

  Modified:    src/main/org/apache/tools/ant/taskdefs/optional Tag:
                        ANT_15_BRANCH StyleBook.java Test.java
  Log:
  both these tasks extend java, so export a lot more than their public API. IF they were used,
they would be in need of cleanup.
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.7.2.1   +27 -4     jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java
  
  Index: StyleBook.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java,v
  retrieving revision 1.7
  retrieving revision 1.7.2.1
  diff -u -r1.7 -r1.7.2.1
  --- StyleBook.java	15 Apr 2002 06:01:37 -0000	1.7
  +++ StyleBook.java	23 Jun 2002 22:45:55 -0000	1.7.2.1
  @@ -60,8 +60,14 @@
   import org.apache.tools.ant.taskdefs.Java;
   
   /**
  - * Basic task for apache stylebook.
  - *
  + * This executes the apache Stylebook documentation generator. 
  + * Unlike the commandline version of this tool, all three arguments
  + * are required to run stylebook.
  + * <p>
  + * Being extended from &lt;Java&gt;, all the parent's attributes
  + * and options are available. Do not set any apart from the <tt>classpath</tt>
  + * as they are not guaranteed to be there in future.
  + * @todo stop extending from Java.
    * @author <a href="mailto:donaldp@apache.org">Peter Donald</a>
    * @author <a href="mailto:marcus.boerger@post.rwth-aachen.de">Marcus
    *      B&ouml;rger</a>
  @@ -80,27 +86,44 @@
           setFailonerror(true);
       }
   
  -
  +    /**
  +     * The book xml file that the documentation generation starts from; 
  +     * required.
  +     */
  +     
       public void setBook(final File book) {
           m_book = book;
       }
   
   
  +    /**
  +     * the directory that contains the stylebook skin;
  +     * required.
  +     */
       public void setSkinDirectory(final File skinDirectory) {
           m_skinDirectory = skinDirectory;
       }
   
   
  +    /**
  +     * the destination directory where the documentation is generated;
  +     * required.
  +     */
       public void setTargetDirectory(final File targetDirectory) {
           m_targetDirectory = targetDirectory;
       }
   
  -
  +    /**
  +     * A loader configuration to send to stylebook; optional.
  +     */
       public void setLoaderConfig(final String loaderConfig) {
           m_loaderConfig = loaderConfig;
       }
   
   
  +    /**
  +     * call the program
  +     */
       public void execute()
            throws BuildException {
   
  
  
  
  1.8.2.1   +22 -0     jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/Test.java
  
  Index: Test.java
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/Test.java,v
  retrieving revision 1.8
  retrieving revision 1.8.2.1
  diff -u -r1.8 -r1.8.2.1
  --- Test.java	15 Apr 2002 14:56:30 -0000	1.8
  +++ Test.java	23 Jun 2002 22:45:55 -0000	1.8.2.1
  @@ -58,6 +58,8 @@
   import java.util.Vector;
   
   /**
  + * This is a primitive task to execute a unit test in the org.apache.testlet framework.
  + * 
    * @author <a href="mailto:donaldp@apache.org">Peter Donald</a>
    */
   public class Test extends Java {
  @@ -65,11 +67,15 @@
       protected Vector m_tests = new Vector();
   
   
  +    /**
  +     * testlet to run
  +     */
       protected static final class TestletEntry {
   
           protected String m_testname = "";
   
   
  +        /** name of test. No property expansion takes place here */
           public void addText(final String testname) {
               m_testname += testname;
           }
  @@ -86,6 +92,9 @@
       }
   
   
  +    /**
  +     * add a declaration of a testlet to run
  +     */
       public TestletEntry createTestlet() {
           final TestletEntry entry = new TestletEntry();
   
  @@ -94,16 +103,29 @@
       }
   
   
  +    /**
  +     * a boolean value indicating whether tests should display a 
  +     * message on success; optional
  +     */
  +    
       public void setShowSuccess(final boolean showSuccess) {
           createArg().setValue("-s=" + showSuccess);
       }
   
   
  +    /**
  +     * a boolean value indicating whether a banner should be displayed 
  +     * when starting testlet engine; optional.
  +     */
       public void setShowBanner(final String showBanner) {
           createArg().setValue("-b=" + showBanner);
       }
   
   
  +    /**
  +     * a boolean indicating that a stack trace is displayed on 
  +     * error (but not normal failure); optional.
  +     */
       public void setShowTrace(final boolean showTrace) {
           createArg().setValue("-t=" + showTrace);
       }
  
  
  

--
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