diff --git a/docs/manual/OptionalTasks/stylebook.html b/docs/manual/OptionalTasks/stylebook.html
index ee6aac98b..58eb0863a 100644
--- a/docs/manual/OptionalTasks/stylebook.html
+++ b/docs/manual/OptionalTasks/stylebook.html
@@ -10,6 +10,10 @@
Description
+
+This task is deprecated as stylebook itself has been
+deprecated by the Apache XML community.
+
This executes the apache Stylebook documentation generator.
Unlike the commandline version of this tool, all three arguments
are required to run stylebook.
diff --git a/docs/manual/install.html b/docs/manual/install.html
index 9c33ae965..617c147f6 100644
--- a/docs/manual/install.html
+++ b/docs/manual/install.html
@@ -325,7 +325,7 @@ you need jakarta-oro 2.0.1 or later, and commons-net<
stylebook.jar |
stylebook task |
- CVS repository of http://xml.apache.org/ |
+ CVS repository of http://xml.apache.org/cvs.html |
testlet.jar |
diff --git a/docs/manual/optionaltasklist.html b/docs/manual/optionaltasklist.html
index 13ef5b577..a42ee3bd7 100644
--- a/docs/manual/optionaltasklist.html
+++ b/docs/manual/optionaltasklist.html
@@ -68,10 +68,10 @@
Splash
Sshexec
Starteam Tasks
-Stylebook
+Stylebook
Symlink
Telnet
-Test
+Test
Translate
Visual Age for Java Tasks
Microsoft Visual SourceSafe Tasks
diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java b/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java
index 7cdc9c3b1..ae740efd0 100644
--- a/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java
+++ b/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 classpath
* 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();
}
}
-