Deprecate stylebook, add javadocs to it - by Kev Jackson

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@278097 13f79535-47bb-0310-9956-ffa450edef68

docs/manual/OptionalTasks/stylebook.html

@@ -10,6 +10,10 @@
 
 <h2><a name="stylebook">Stylebook</a></h2>
 <h3>Description</h3>
+
+<strong>This task is deprecated as stylebook itself has been
+deprecated by the Apache XML community.</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>

docs/manual/install.html

@@ -325,7 +325,7 @@ you need jakarta-oro 2.0.1 or later, and <a href="#commons-net">commons-net</a><
   <tr>
     <td>stylebook.jar</td>
     <td>stylebook task</td>
-    <td>CVS repository of <a href="http://xml.apache.org/" target="_top">http://xml.apache.org/</a></td>
+    <td>CVS repository of <a href="http://xml.apache.org/cvs.html" target="_top">http://xml.apache.org/cvs.html</a></td>
   </tr>
   <tr>
     <td>testlet.jar</td>

docs/manual/optionaltasklist.html

@@ -68,10 +68,10 @@
 <a href="OptionalTasks/splash.html">Splash</a><br>
 <a href="OptionalTasks/sshexec.html">Sshexec</a><br>
 <a href="OptionalTasks/starteam.html">Starteam Tasks</a><br>
-<a href="OptionalTasks/stylebook.html">Stylebook</a><br>
+<a href="OptionalTasks/stylebook.html"><i>Stylebook</i></a><br>
 <a href="OptionalTasks/symlink.html">Symlink</a><br>
 <a href="OptionalTasks/telnet.html">Telnet</a><br>
-<a href="OptionalTasks/test.html">Test</a><br>
+<a href="OptionalTasks/test.html"><i>Test</i></a><br>
 <a href="OptionalTasks/translate.html">Translate</a><br>
 <a href="Integration/VAJAntTool.html#tasks">Visual Age for Java Tasks</a><br>
 <a href="OptionalTasks/vss.html#tasks">Microsoft Visual SourceSafe Tasks</a><br>

src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java

@@ -1,5 +1,5 @@
 /*
- * Copyright  2000-2002,2004 The Apache Software Foundation
+ * Copyright  2000-2002,2004-2005 The Apache Software Foundation
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -29,6 +29,7 @@ import org.apache.tools.ant.taskdefs.Java;
  * 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;
@@ -37,6 +38,9 @@ public class StyleBook extends Java {
     protected File m_book;
 
 
+    /**
+     * Constructor
+     */
     public StyleBook() {
         setClassname("org.apache.stylebook.StyleBook");
         setFork(true);
@@ -44,8 +48,9 @@ public class StyleBook extends Java {
     }
 
     /**
-     * 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) {
@@ -54,8 +59,9 @@ public class StyleBook extends Java {
 
 
     /**
-     * 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;
@@ -63,8 +69,9 @@ public class StyleBook extends Java {
 
 
     /**
-     * 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;
@@ -72,6 +79,7 @@ public class StyleBook extends Java {
 
     /**
      * A loader configuration to send to stylebook; optional.
+     * @param loaderConfig
      */
     public void setLoaderConfig(final String loaderConfig) {
         m_loaderConfig = loaderConfig;
@@ -106,4 +114,3 @@ public class StyleBook extends Java {
         super.execute();
     }
 }
-