Author: vsiveton
Date: Wed Jul 30 03:50:08 2008
New Revision: 680970
URL: http://svn.apache.org/viewvc?rev=680970&view=rev
Log:
o sort options
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java?rev=680970&r1=680969&r2=680970&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
Wed Jul 30 03:50:08 2008
@@ -407,17 +407,6 @@
private String doclet;
/**
- * Specifies the path to the doclet starting class file (specified with
the -doclet option) and any jar files
- * it depends on. The docletPath can contain multiple paths by separating
them with a colon (<code>:</code>)
- * on Solaris and a semi-colon (<code>;</code>) on Windows.
- * <br/>
- * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docletpath";>docletpath</a>.
- *
- * @parameter expression="${docletPath}"
- */
- private String docletPath;
-
- /**
* Specifies the artifact containing the doclet starting class file
(specified with the -doclet option).
* <br/>
* See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docletpath";>docletpath</a>.
@@ -464,6 +453,17 @@
private DocletArtifact[] docletArtifacts;
/**
+ * Specifies the path to the doclet starting class file (specified with
the -doclet option) and any jar files
+ * it depends on. The docletPath can contain multiple paths by separating
them with a colon (<code>:</code>)
+ * on Solaris and a semi-colon (<code>;</code>) on Windows.
+ * <br/>
+ * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docletpath";>docletpath</a>.
+ *
+ * @parameter expression="${docletPath}"
+ */
+ private String docletPath;
+
+ /**
* Specifies the encoding name of the source files.
* <br/>
* See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#encoding";>encoding</a>.
@@ -530,6 +530,30 @@
private String minmemory;
/**
+ * This option creates documentation with the appearance and functionality
of documentation generated by
+ * Javadoc 1.1.
+ * <br/>
+ * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#1.1";>1.1</a>.
+ * <br/>
+ *
+ * @parameter expression="${old}" default-value="false"
+ */
+ private boolean old;
+
+ /**
+ * Specifies that javadoc should retrieve the text for the overview
documentation from the "source" file
+ * specified by path/filename and place it on the Overview page
(overview-summary.html).
+ * <br/>
+ * <b>Note</b>: could be in conflict with <nooverview/>.
+ * <br/>
+ * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#overview";>overview</a>.
+ * <br/>
+ *
+ * @parameter expression="${overview}"
default-value="${basedir}/src/main/javadoc/overview.html"
+ */
+ private File overview;
+
+ /**
* Specifies the proxy host where the javadoc web access in
<code>-link</code> would pass through.
* It defaults to the proxy host of the active proxy set in the
<code>settings.xml</code>, otherwise it gets the
* proxy configuration set in the pom.
@@ -552,28 +576,20 @@
private int proxyPort;
/**
- * This option creates documentation with the appearance and functionality
of documentation generated by
- * Javadoc 1.1.
- * <br/>
- * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#1.1";>1.1</a>.
+ * Shuts off non-error and non-warning messages, leaving only the warnings
and errors appear, making them
+ * easier to view.
* <br/>
- *
- * @parameter expression="${old}" default-value="false"
- */
- private boolean old;
-
- /**
- * Specifies that javadoc should retrieve the text for the overview
documentation from the "source" file
- * specified by path/filename and place it on the Overview page
(overview-summary.html).
+ * Note: was a standard doclet in Java 1.4.2 (refer to bug ID
+ * <a
href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4714350";>4714350</a>).
* <br/>
- * <b>Note</b>: could be in conflict with <nooverview/>.
+ * See <a
href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#quiet";>quiet</a>.
* <br/>
- * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#overview";>overview</a>.
+ * Since Java 5.0.
* <br/>
*
- * @parameter expression="${overview}"
default-value="${basedir}/src/main/javadoc/overview.html"
+ * @parameter expression="${quiet}" default-value="false"
*/
- private File overview;
+ private boolean quiet;
/**
* Specifies the access level for classes and members to show in the
Javadocs.
@@ -595,22 +611,6 @@
private String show;
/**
- * Shuts off non-error and non-warning messages, leaving only the warnings
and errors appear, making them
- * easier to view.
- * <br/>
- * Note: was a standard doclet in Java 1.4.2 (refer to bug ID
- * <a
href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4714350";>4714350</a>).
- * <br/>
- * See <a
href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#quiet";>quiet</a>.
- * <br/>
- * Since Java 5.0.
- * <br/>
- *
- * @parameter expression="${quiet}" default-value="false"
- */
- private boolean quiet;
-
- /**
* Necessary to enable javadoc to handle assertions present in J2SE v 1.4
source code.
* <br/>
* See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#source";>source</a>.
@@ -691,15 +691,13 @@
private String charset;
/**
- * Specifies the destination directory where javadoc saves the generated
HTML files.
- * <br/>
- * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#d";>d</a>.
+ * Specifies the encoding of the generated HTML files.
* <br/>
+ * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docencoding";>docencoding</a>.
*
- * @parameter expression="${destDir}" alias="destDir"
default-value="${project.build.directory}/apidocs"
- * @required
+ * @parameter expression="${docencoding}"
default-value="${project.reporting.outputEncoding}"
*/
- protected File outputDirectory;
+ private String docencoding;
/**
* Enables deep copying of "doc-files" directories.
@@ -715,15 +713,6 @@
private boolean docfilessubdirs;
/**
- * Specifies the encoding of the generated HTML files.
- * <br/>
- * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docencoding";>docencoding</a>.
- *
- * @parameter expression="${docencoding}"
default-value="${project.reporting.outputEncoding}"
- */
- private String docencoding;
-
- /**
* Specifies the title to be placed near the top of the overview summary
file.
* <br/>
* See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#doctitle";>doctitle</a>.
@@ -828,29 +817,6 @@
protected ArrayList links;
/**
- * This option is a variation of -link; they both create links to
javadoc-generated documentation for external
- * referenced classes.
- * <br/>
- * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#linkoffline";>linkoffline</a>.
- * <br/>
- * Example:
- * <pre>
- * <offlineLinks>
- * <offlineLink>
- *
<url>http://java.sun.com/j2se/1.5.0/docs/api/</url>
- *
<location>../javadoc/jdk-5.0/</location>
- * </offlineLink>
- * </offlineLinks>
- * </pre>
- * <br/>
- * See <a
href="./apidocs/org/apache/maven/plugin/javadoc/options/OfflineLink.html">Javadoc</a>.
- * <br/>
- *
- * @parameter expression="${offlineLinks}"
- */
- private OfflineLink[] offlineLinks;
-
- /**
* Creates an HTML version of each source file (with line numbers) and
adds links to them from the standard
* HTML documentation.
* <br/>
@@ -990,6 +956,40 @@
private boolean notree;
/**
+ * This option is a variation of -link; they both create links to
javadoc-generated documentation for external
+ * referenced classes.
+ * <br/>
+ * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#linkoffline";>linkoffline</a>.
+ * <br/>
+ * Example:
+ * <pre>
+ * <offlineLinks>
+ * <offlineLink>
+ *
<url>http://java.sun.com/j2se/1.5.0/docs/api/</url>
+ *
<location>../javadoc/jdk-5.0/</location>
+ * </offlineLink>
+ * </offlineLinks>
+ * </pre>
+ * <br/>
+ * See <a
href="./apidocs/org/apache/maven/plugin/javadoc/options/OfflineLink.html">Javadoc</a>.
+ * <br/>
+ *
+ * @parameter expression="${offlineLinks}"
+ */
+ private OfflineLink[] offlineLinks;
+
+ /**
+ * Specifies the destination directory where javadoc saves the generated
HTML files.
+ * <br/>
+ * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#d";>d</a>.
+ * <br/>
+ *
+ * @parameter expression="${destDir}" alias="destDir"
default-value="${project.build.directory}/apidocs"
+ * @required
+ */
+ protected File outputDirectory;
+
+ /**
* Specify the text for upper left frame.
* <br/>
* Since <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.2.html#commandlineoptions";>
@@ -1060,31 +1060,6 @@
private String stylesheetfile;
/**
- * Enables the Javadoc tool to interpret a simple, one-argument custom
block tag tagname in doc comments.
- * <br/>
- * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tag";>tag</a>.
- * <br/>
- * Since <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
- * <br/>
- * Example:
- * <pre>
- * <tags>
- * <tag>
- * <name>todo</name>
- * <placement>a</placement>
- * <head>To Do:</head>
- * </tag>
- * </tags>
- * </pre>
- * <br/>
- * See <a
href="./apidocs/org/apache/maven/plugin/javadoc/options/Tag.html">Javadoc</a>.
- * <br/>
- *
- * @parameter expression="${tags}"
- */
- private Tag[] tags;
-
- /**
* Specifies the class file that starts the taglet used in generating the
documentation for that tag.
* <br/>
* See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#taglet";>taglet</a>.
@@ -1096,19 +1071,6 @@
private String taglet;
/**
- * Specifies the search paths for finding taglet class files (.class). The
tagletPath can contain
- * multiple paths by separating them with a colon (<code>:</code>) on
Solaris and a semi-colon (<code>;</code>)
- * on Windows.
- * <br/>
- * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tagletpath";>tagletpath</a>.
- * <br/>
- * Since <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
- *
- * @parameter expression="${tagletpath}"
- */
- private String tagletpath;
-
- /**
* Specifies the Taglet artifact containing the taglet class files
(.class).
* <br/>
* See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tagletpath";>tagletpath</a>.
@@ -1168,6 +1130,19 @@
private TagletArtifact[] tagletArtifacts;
/**
+ * Specifies the search paths for finding taglet class files (.class). The
tagletPath can contain
+ * multiple paths by separating them with a colon (<code>:</code>) on
Solaris and a semi-colon (<code>;</code>)
+ * on Windows.
+ * <br/>
+ * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tagletpath";>tagletpath</a>.
+ * <br/>
+ * Since <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
+ *
+ * @parameter expression="${tagletpath}"
+ */
+ private String tagletpath;
+
+ /**
* Enables the Javadoc tool to interpret multiple taglets.
* <br/>
* See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#taglet";>taglet</a>.
@@ -1198,6 +1173,31 @@
private Taglet[] taglets;
/**
+ * Enables the Javadoc tool to interpret a simple, one-argument custom
block tag tagname in doc comments.
+ * <br/>
+ * See <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tag";>tag</a>.
+ * <br/>
+ * Since <a
href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary";>Java
1.4</a>.
+ * <br/>
+ * Example:
+ * <pre>
+ * <tags>
+ * <tag>
+ * <name>todo</name>
+ * <placement>a</placement>
+ * <head>To Do:</head>
+ * </tag>
+ * </tags>
+ * </pre>
+ * <br/>
+ * See <a
href="./apidocs/org/apache/maven/plugin/javadoc/options/Tag.html">Javadoc</a>.
+ * <br/>
+ *
+ * @parameter expression="${tags}"
+ */
+ private Tag[] tags;
+
+ /**
* Specifies the top text to be placed at the top of each output file.
* <br/>
* See <a
href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6227616";>6227616</a>.
