bodewig 2005/03/31 03:24:06
Modified: docs/manual install.html optionaltasklist.html
docs/manual/OptionalTasks stylebook.html
src/main/org/apache/tools/ant/taskdefs/optional
StyleBook.java
Log:
Deprecate stylebook, add javadocs to it - by Kev Jackson
Revision Changes Path
1.79 +1 -1 ant/docs/manual/install.html
Index: install.html
===================================================================
RCS file: /home/cvs/ant/docs/manual/install.html,v
retrieving revision 1.78
retrieving revision 1.79
diff -u -r1.78 -r1.79
--- install.html 14 Mar 2005 09:44:42 -0000 1.78
+++ install.html 31 Mar 2005 11:24:06 -0000 1.79
@@ -325,7 +325,7 @@
<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>
1.43 +2 -2 ant/docs/manual/optionaltasklist.html
Index: optionaltasklist.html
===================================================================
RCS file: /home/cvs/ant/docs/manual/optionaltasklist.html,v
retrieving revision 1.42
retrieving revision 1.43
diff -u -r1.42 -r1.43
--- optionaltasklist.html 7 Mar 2005 18:38:26 -0000 1.42
+++ optionaltasklist.html 31 Mar 2005 11:24:06 -0000 1.43
@@ -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>
1.11 +4 -0 ant/docs/manual/OptionalTasks/stylebook.html
Index: stylebook.html
===================================================================
RCS file: /home/cvs/ant/docs/manual/OptionalTasks/stylebook.html,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- stylebook.html 7 Mar 2005 18:11:14 -0000 1.10
+++ stylebook.html 31 Mar 2005 11:24:06 -0000 1.11
@@ -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>
1.17 +12 -5 ant/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java
Index: StyleBook.java
===================================================================
RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/StyleBook.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- StyleBook.java 9 Mar 2004 16:48:15 -0000 1.16
+++ StyleBook.java 31 Mar 2005 11:24:06 -0000 1.17
@@ -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 @@
* 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 @@
protected File m_book;
+ /**
+ * Constructor
+ */
public StyleBook() {
setClassname("org.apache.stylebook.StyleBook");
setFork(true);
@@ -44,8 +48,9 @@
}
/**
- * 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 @@
/**
- * 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 @@
/**
- * 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 @@
/**
* A loader configuration to send to stylebook; optional.
+ * @param loaderConfig
*/
public void setLoaderConfig(final String loaderConfig) {
m_loaderConfig = loaderConfig;
@@ -106,4 +114,3 @@
super.execute();
}
}
-
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org
|