[prev in list] [next in list] [prev in thread] [next in thread] 

List:       ant-dev
Subject:    Re: [patch] Stylebook task javadoc
From:       Kev Jackson <kevin.jackson () it ! fts-vn ! com>
Date:       2005-03-31 8:46:11
Message-ID: 424BB8D3.1030102 () it ! fts-vn ! com
[Download RAW message or body]

here's the @deprecated stylebook and doc changes to 
OptionalTasks/stylebook.html

(sorry the other changes are in the stylebook patch too)

Kev

["stylebook-patch.txt" (text/plain)]

Index: StyleBook.java
===================================================================
RCS file: /home/cvspublic/ant/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java,v
retrieving revision 1.16
diff -u -r1.16 StyleBook.java
--- StyleBook.java	9 Mar 2004 16:48:15 -0000	1.16
+++ StyleBook.java	31 Mar 2005 08:42:57 -0000
@@ -29,14 +29,18 @@
  * 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.
+ * @deprecated This task is considered unsupported by the Ant developers
  */
 public class StyleBook extends Java {
-    protected File m_targetDirectory;
-    protected File m_skinDirectory;
-    protected String m_loaderConfig;
-    protected File m_book;
+    protected File targetDirectory;
+    protected File skinDirectory;
+    protected String loaderConfig;
+    protected File book;
 
 
+    /**
+     * Constructor
+     */
     public StyleBook() {
         setClassname("org.apache.stylebook.StyleBook");
         setFork(true);
@@ -44,37 +48,41 @@
     }
 
     /**
-     * The book xml file that the documentation generation starts from;
+     * Set the book xml file that the documentation generation starts from;
      * required.
+     * @param book the source file
      */
 
     public void setBook(final File book) {
-        m_book = book;
+        this.book = book;
     }
 
 
     /**
-     * the directory that contains the stylebook skin;
+     * Set the directory that contains the stylebook skin;
      * required.
+     * @param skinDirectory the location of the stylebook skin 
      */
     public void setSkinDirectory(final File skinDirectory) {
-        m_skinDirectory = skinDirectory;
+        this.skinDirectory = skinDirectory;
     }
 
 
     /**
-     * the destination directory where the documentation is generated;
+     * Set the destination directory where the documentation is generated;
      * required.
+     * @param targetDirectory the document output directory
      */
     public void setTargetDirectory(final File targetDirectory) {
-        m_targetDirectory = targetDirectory;
+        this.targetDirectory = targetDirectory;
     }
 
     /**
      * A loader configuration to send to stylebook; optional.
+     * @param loaderConfig
      */
     public void setLoaderConfig(final String loaderConfig) {
-        m_loaderConfig = loaderConfig;
+        this.loaderConfig = loaderConfig;
     }
 
 
@@ -84,26 +92,25 @@
     public void execute()
          throws BuildException {
 
-        if (null == m_targetDirectory) {
+        if (null == targetDirectory) {
             throw new BuildException("TargetDirectory attribute not set.");
         }
 
-        if (null == m_skinDirectory) {
+        if (null == skinDirectory) {
             throw new BuildException("SkinDirectory attribute not set.");
         }
 
-        if (null == m_book) {
+        if (null == book) {
             throw new BuildException("book attribute not set.");
         }
 
-        createArg().setValue("targetDirectory=" + m_targetDirectory);
-        createArg().setValue(m_book.toString());
-        createArg().setValue(m_skinDirectory.toString());
-        if (null != m_loaderConfig) {
-            createArg().setValue("loaderConfig=" + m_loaderConfig);
+        createArg().setValue("targetDirectory=" + targetDirectory);
+        createArg().setValue(book.toString());
+        createArg().setValue(skinDirectory.toString());
+        if (null != loaderConfig) {
+            createArg().setValue("loaderConfig=" + loaderConfig);
         }
 
         super.execute();
     }
 }
-

["html-patch.txt" (text/plain)]

Index: stylebook.html
===================================================================
RCS file: /home/cvspublic/ant/docs/manual/OptionalTasks/stylebook.html,v
retrieving revision 1.10
diff -u -r1.10 stylebook.html
--- stylebook.html	7 Mar 2005 18:11:14 -0000	1.10
+++ stylebook.html	31 Mar 2005 08:41:25 -0000
@@ -8,8 +8,9 @@
 
 <body>
 
-<h2><a name="stylebook">Stylebook</a></h2>
+<h2><a name="stylebook">Stylebook <i>deprecated</i></a></h2>
 <h3>Description</h3>
+<strong>This task is no longer supported by the Ant developers</strong>
 <p>This executes the apache Stylebook documentation generator. 
 Unlike the commandline version of this tool, all three arguments
 are required to run stylebook.</p>



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org

[prev in list] [next in list] [prev in thread] [next in thread]