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 17 Dec 2004 04:17:48 -0000
@@ -31,12 +31,16 @@
* @todo stop extending from Java.
*/
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 for StyleBook
+ * calls setX methods to configure
+ */
public StyleBook() {
setClassname("org.apache.stylebook.StyleBook");
setFork(true);
@@ -46,61 +50,65 @@
/**
* The book xml file that the documentation generation starts from;
* required.
+ * @param book the xml file that is needed to generate the documentation
*/
public void setBook(final File book) {
- m_book = book;
+ this.book = book;
}
/**
- * the directory that contains the stylebook skin;
+ * The directory that contains the stylebook skin;
* required.
+ * @param directory the directory that contains the stylebook skin
*/
public void setSkinDirectory(final File skinDirectory) {
- m_skinDirectory = skinDirectory;
+ this.skinDirectory = skinDirectory;
}
/**
- * the destination directory where the documentation is generated;
+ * The destination directory where the documentation is generated;
* required.
+ * @param targetDirectory the location of the generated docs
*/
public void setTargetDirectory(final File targetDirectory) {
- m_targetDirectory = targetDirectory;
+ this.targetDirectory = targetDirectory;
}
/**
* A loader configuration to send to stylebook; optional.
+ * @param loaderConfig to pass to the stylebook
*/
public void setLoaderConfig(final String loaderConfig) {
- m_loaderConfig = loaderConfig;
+ this.loaderConfig = loaderConfig;
}
/**
- * call the program
+ * Call the program
*/
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();
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
