aheritier 2004/06/09 15:28:03
Modified: javadoc plugin.properties
javadoc/xdocs properties.xml
Log:
Update the javadoc plugin's properties and docs
Revision Changes Path
1.12 +16 -7 maven-plugins/javadoc/plugin.properties
Index: plugin.properties
===================================================================
RCS file: /home/cvs/maven-plugins/javadoc/plugin.properties,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- plugin.properties 2 Apr 2004 03:48:57 -0000 1.11
+++ plugin.properties 9 Jun 2004 22:28:03 -0000 1.12
@@ -20,23 +20,32 @@
# Javadoc plugin.
# -------------------------------------------------------------------
+#maven.javadoc.additionalparam
maven.javadoc.author = true
+#maven.javadoc.customtags
maven.javadoc.destdir = ${maven.docs.dest}/apidocs
# optional properties for specifying a custom doclet
-#maven.javadoc.docletpath=
#maven.javadoc.doclet=
+#maven.javadoc.docletpath=
maven.javadoc.links =
+
+#specify an alternate locale
+#maven.javadoc.locale=en_US
#maven.javadoc.maxmemory
-maven.javadoc.public = false
+
+#maven.javadoc.mode.online
+#maven.javadoc.offlineLinks
+#maven.javadoc.overview
maven.javadoc.package = true
maven.javadoc.private = false
+maven.javadoc.public = false
+#maven.javadoc.source
maven.javadoc.stylesheet = ${plugin.resources}/stylesheet.css
+#maven.javadoc.tagletpath
+#maven.javadoc.taglets
maven.javadoc.use = true
-maven.javadoc.version = true
maven.javadoc.useexternalfile = yes
-maven.javadoc.windowtitle = ${pom.name} ${pom.currentVersion} API
-
-#specify an alternate locale
-#maven.javadoc.locale=en_US
+maven.javadoc.version = true
+maven.javadoc.windowtitle = ${pom.name} ${pom.currentVersion} API
\ No newline at end of file
1.14 +83 -82 maven-plugins/javadoc/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/maven-plugins/javadoc/xdocs/properties.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- properties.xml 4 Mar 2004 18:35:59 -0000 1.13
+++ properties.xml 9 Jun 2004 22:28:03 -0000 1.14
@@ -16,18 +16,30 @@
* limitations under the License.
*/
-->
-
<document>
-
<properties>
<title>Javadoc Properties</title>
<author email="[EMAIL PROTECTED]">Stéphane MOR</author>
</properties>
-
<body>
- <section name="Javadoc Settings">
+ <section name="Javadoc Settings">
<table>
- <tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>maven.javadoc.additionalparam</td>
+ <td>Yes</td>
+ <td>
+ Specifies additional parameters added to the javadoc command line.
+ <p>Example (sets generated Javadocs encoding to utf-8):</p>
+ <source>
+maven.javadoc.additionalparam=-charset utf-8
+ </source>
+ </td>
+ </tr>
<tr>
<td>maven.javadoc.author</td>
<td>Yes</td>
@@ -39,6 +51,29 @@
</td>
</tr>
<tr>
+ <td>maven.javadoc.customtags</td>
+ <td>Yes</td>
+ <td>
+ Specifies custom tags to use for the generated
+ Javadocs. You can specify some tags separate by space.
+ Each tag is describe in sub properties.
+ This option is only available with Java 1.4.
+ Sample :
+ <source><![CDATA[
+maven.javadoc.customtags=tag1 tag2
+tag1.name=todo
+tag1.description=To Do:
+tag1.enabled=true
+tag1.scope=all
+
+tag2.name=task
+tag2.description=Task:
+tag2.enabled=false
+tag2.scope=all
+ ]]></source>
+ </td>
+ </tr>
+ <tr>
<td>maven.javadoc.destdir</td>
<td>Yes</td>
<td>
@@ -67,17 +102,6 @@
</td>
</tr>
<tr>
- <td>maven.javadoc.doctitle</td>
- <td>Yes</td>
- <td>
- Specifies the document title to use for the generated
- Javadocs. The default value is <code>${maven.name}
- ${maven.currentVersion} API</code>. <code>${maven.name}</code>
- and <code>${maven.currentVersion}</code> expand to values obtained
- from the project descriptor.
- </td>
- </tr>
- <tr>
<td>maven.javadoc.links</td>
<td>Yes</td>
<td>
@@ -108,7 +132,18 @@
</td>
</tr>
<tr>
- <td><a name="maven.javadoc.mode.online">maven.javadoc.mode.online</a></td>
+ <td>maven.javadoc.maxmemory</td>
+ <td>Yes</td>
+ <td>
+ Specifies the maximum Java heap size to be used when launching
+ the javadoc executable. Some JVMs refer to this property as
+ the <code>-Xmx</code> parameter.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a name="maven.javadoc.mode.online">maven.javadoc.mode.online</a>
+ </td>
<td>Yes</td>
<td>
<p>
@@ -160,9 +195,18 @@
</td>
</tr>
<tr>
+ <td>maven.javadoc.overview</td>
+ <td>Yes</td>
+ <td>
+ Filename.
+ Add additional overview documentation to the overview page of the
javadoc.
+ The documentation must be an HTML file, specified relative to the
project.xml.
+ </td>
+ </tr>
+ <tr>
<td>
- maven.javadoc.public<br />
- maven.javadoc.package<br />
+ maven.javadoc.public<br/>
+ maven.javadoc.package<br/>
maven.javadoc.private
</td>
<td>Yes</td>
@@ -174,28 +218,30 @@
</td>
</tr>
<tr>
- <td>maven.javadoc.maxmemory</td>
+ <td>maven.javadoc.source</td>
<td>Yes</td>
<td>
- Specifies the maximum Java heap size to be used when launching
- the javadoc executable. Some JVMs refer to this property as
- the <code>-Xmx</code> parameter.
+ Specifies the version of the jdk in use. See
+ <a href="http://ant.apache.org/manual/CoreTasks/javadoc.html";>the
+ ant javadoc task</a> documentation for more detail.
</td>
</tr>
<tr>
- <td>maven.javadoc.overview</td>
+ <td>maven.javadoc.stylesheet</td>
<td>Yes</td>
<td>
- Filename.
- Add additional overview documentation to the overview page of the
javadoc.
- The documentation must be an HTML file, specified relative to the
project.xml.
+ Specifies the stylesheet file to use for the javadoc.
+ Default is <code>${plugin.resources}/stylesheet.css</code>
</td>
</tr>
<tr>
- <td>maven.javadoc.source</td>
+ <td>
+ <a name="maven.javadoc.tagletpath">maven.javadoc.tagletpath</a>
+ </td>
<td>Yes</td>
<td>
- Specifies the version of the jdk in use. See
+ Specifies the path to the taglet classes when calling javadoc
+ with taglets. See
<a href="http://ant.apache.org/manual/CoreTasks/javadoc.html";>the
ant javadoc task</a> documentation for more detail.
</td>
@@ -213,22 +259,21 @@
</td>
</tr>
<tr>
- <td><a name="maven.javadoc.tagletpath">maven.javadoc.tagletpath</a></td>
+ <td>maven.javadoc.use</td>
<td>Yes</td>
<td>
- Specifies the path to the taglet classes when calling javadoc
- with taglets. See
- <a href="http://ant.apache.org/manual/CoreTasks/javadoc.html";>the
- ant javadoc task</a> documentation for more detail.
+ Boolean value.
+ If <code>true</code>, a "use" page is generated for each class and
member.
+ The default value is <code>true</code>.
</td>
</tr>
<tr>
- <td>maven.javadoc.use</td>
+ <td>maven.javadoc.useexternalfile</td>
<td>Yes</td>
<td>
- Boolean value.
- If <code>true</code>, a "use" page is generated for each class and
member.
- The default value is <code>true</code>.
+ indicates whether the sourcefile name specified in srcfiles or as
+ nested source elements should be written to a temporary file to make
+ the command line shorter. Default value : no.
</td>
</tr>
<tr>
@@ -249,50 +294,6 @@
<code>${pom.name} ${pom.currentVersion} API</code>.
<code>${pom.name}</code> and <code>${maven.currentVersion}</code>
expand to values obtained from the project descriptor.
- </td>
- </tr>
- <tr>
- <td>maven.javadoc.useexternalfile</td>
- <td>Yes</td>
- <td>
- indicates whether the sourcefile name specified in srcfiles or as
- nested source elements should be written to a temporary file to make
- the command line shorter. Default value : no.
- </td>
- </tr>
- <tr>
- <td>maven.javadoc.customtags</td>
- <td>Yes</td>
- <td>
- Specifies custom tags to use for the generated
- Javadocs. You can specify some tags separate by space.
- Each tag is describe in sub properties.
- This option is only available with Java 1.4.
- Sample :
- <source><![CDATA[
-maven.javadoc.customtags=tag1 tag2
-tag1.name=todo
-tag1.description=To Do:
-tag1.enabled=true
-tag1.scope=all
-
-tag2.name=task
-tag2.description=Task:
-tag2.enabled=false
-tag2.scope=all
- ]]>
- </source>
- </td>
- </tr>
- <tr>
- <td>maven.javadoc.additionalparam</td>
- <td>Yes</td>
- <td>
- Specifies additional parameters added to the javadoc command line.
- <p>Example (sets generated Javadocs encoding to utf-8):</p>
- <source>
-maven.javadoc.additionalparam=-charset utf-8
- </source>
</td>
</tr>
</table>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
