You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by ah...@apache.org on 2004/09/26 15:51:04 UTC
cvs commit: maven-plugins/javadoc/xdocs faq.fml navigation.xml properties.xml
aheritier 2004/09/26 06:51:04
Modified: javadoc/xdocs navigation.xml properties.xml
Added: javadoc/xdocs faq.fml
Log:
docs improvement
Revision Changes Path
1.5 +9 -8 maven-plugins/javadoc/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/maven-plugins/javadoc/xdocs/navigation.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- navigation.xml 7 Jul 2004 21:21:45 -0000 1.4
+++ navigation.xml 26 Sep 2004 13:51:04 -0000 1.5
@@ -16,19 +16,20 @@
* limitations under the License.
*/
-->
-
<project name="Maven Javadoc Plugin">
-
<title>Maven Javadoc Plugin</title>
-
<body>
<links>
- <item name="Maven" href="http://maven.apache.org/"/>
- <item name="Javadoc" href="http://java.sun.com/j2se/javadoc/"/>
+ <item name="Maven" href="http://maven.apache.org/"/>
+ <item name="Javadoc" href="http://java.sun.com/j2se/javadoc/"/>
</links>
<menu name="Overview">
- <item name="Goals" href="/goals.html" />
- <item name="Properties" href="/properties.html" />
+ <item name="About" href="/index.html"/>
+ <item name="Goals" href="/goals.html"/>
+ <item name="Properties" href="/properties.html"/>
+ <item name="FAQ" href="/faq.html"/>
+ <item name="Downloads" href="/downloads.html"/>
+ <item name="History" href="/changes-report.html"/>
</menu>
</body>
-</project>
\ No newline at end of file
+</project>
1.23 +115 -132 maven-plugins/javadoc/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/maven-plugins/javadoc/xdocs/properties.xml,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- properties.xml 24 Sep 2004 22:52:08 -0000 1.22
+++ properties.xml 26 Sep 2004 13:51:04 -0000 1.23
@@ -20,6 +20,7 @@
<properties>
<title>Javadoc Properties</title>
<author email="smor@apache.org">St�phane MOR</author>
+ <author email="aheritier@apache.org">Arnaud HERITIER</author>
</properties>
<body>
<section name="Javadoc Settings">
@@ -34,13 +35,114 @@
<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>
+ <p>Example (to print what version of javadoc you are using):</p>
+ <source>maven.javadoc.additionalparam=-J-showversion</source>
</td>
</tr>
<tr>
+ <td>maven.javadoc.debug</td>
+ <td>Yes</td>
+ <td>
+ Print informations to debug the plugin.
+ The default value is <code>false</code>.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.javadoc.doclet</td>
+ <td>Yes</td>
+ <td>
+ Specifies the doclet to use when calling javadoc. 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.docletpath</td>
+ <td>Yes</td>
+ <td>
+ Specifies the path to the doclet class when calling javadoc with a
+ custom doclet. 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.excludepackagenames</td>
+ <td>Yes</td>
+ <td>
+ Comma separated list of packages to exclude from the javadoc.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.javadoc.locale</td>
+ <td>Yes</td>
+ <td>
+ <p>
+ Locale to be used, e.g. en_US or en_US_WIN.
+ Works like the "-locale" option of the javadoc command.
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <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>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.private
+ </td>
+ <td>Yes</td>
+ <td>
+ Boolean value.
+ The scope of classes and members to include in the javadoc.
+ A <code>true</code> value includes that scope and higher.
+ The default value is to include protected scope and higher.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.javadoc.source</td>
+ <td>Yes</td>
+ <td>
+ 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.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>
+ </table>
+ </section>
+ <section name="Standard Doclet Settings">
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Description</th>
+ </tr>
+ <tr>
<td>maven.javadoc.author</td>
<td>Yes</td>
<td>
@@ -59,7 +161,7 @@
<code>${pom.organization.name}</code>
expand to value obtained from the project descriptor.
</td>
- </tr>
+ </tr>
<tr>
<td>maven.javadoc.customtags</td>
<td>Yes</td>
@@ -84,14 +186,6 @@
</td>
</tr>
<tr>
- <td>maven.javadoc.debug</td>
- <td>Yes</td>
- <td>
- Print informations to debug the plugin.
- The default value is <code>false</code>.
- </td>
- </tr>
- <tr>
<td>maven.javadoc.destdir</td>
<td>Yes</td>
<td>
@@ -101,32 +195,6 @@
</td>
</tr>
<tr>
- <td>maven.javadoc.doclet</td>
- <td>Yes</td>
- <td>
- Specifies the doclet to use when calling javadoc. 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.docletpath</td>
- <td>Yes</td>
- <td>
- Specifies the path to the doclet class when calling javadoc with a
- custom doclet. 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.excludepackagenames</td>
- <td>Yes</td>
- <td>
- Comma separated list of packages to exclude from the javadoc.
- </td>
- </tr>
- <tr>
<td>maven.javadoc.links</td>
<td>Yes</td>
<td>
@@ -136,33 +204,7 @@
<a href="#maven.javadoc.mode.online">maven.javadoc.mode.online</a>).
Works like the "-link" option of the javadoc command.
</p>
- <p>
- The URLs must link to a directory where the javadoc generated file
- "package-list" is accesible for the package.
- </p>
- <p>Example:</p>
- <source>
-maven.javadoc.links=http://java.sun.com/j2se/1.4.2/docs/api/, http://maven.apache.org/apidocs/
- </source>
- </td>
- </tr>
- <tr>
- <td>maven.javadoc.locale</td>
- <td>Yes</td>
- <td>
- <p>
- Locale to be used, e.g. en_US or en_US_WIN.
- Works like the "-locale" option of the javadoc command.
- </p>
- </td>
- </tr>
- <tr>
- <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.
+ <p>See the <a href="faq.html#links">FAQ</a> for more details.</p>
</td>
</tr>
<tr>
@@ -198,57 +240,7 @@
<a href="#maven.javadoc.mode.online">maven.javadoc.mode.online</a>).
Works like the "-linkoffline" option of the javadoc command.
</p>
- <p>
- The URLs must link to a directory where the javadoc generated file
- "package-list" is accesible for the package.
- </p>
- <p>Example (generates <b>offline</b> links in offline mode):</p>
- <source>
-maven.javadoc.offlineLinks=/opt/java-apidoc/j2sdk1.4.1/docs/api/, /cvsroot/maven/target/docs/apidocs/
- </source>
- <p>
- Generation of online javadoc links in offline mode is also possible.
- You need to provide the online URL plus the a offline directory
- resource for "package-list". URL and directory need to be seperated
- by the "#" character.
- </p>
- <p>Example (generates <b>online</b> links in offline mode):</p>
- <source>
-maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-apidoc/j2sdk1.4.1/docs/api/, \
- http://maven.apache.org/apidocs/#/cvsroot/maven/target/docs/apidocs/
- </source>
- </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.private
- </td>
- <td>Yes</td>
- <td>
- Boolean value.
- The scope of classes and members to include in the javadoc.
- A <code>true</code> value includes that scope and higher.
- The default value is to include protected scope and higher.
- </td>
- </tr>
- <tr>
- <td>maven.javadoc.source</td>
- <td>Yes</td>
- <td>
- 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.
+ <p>See the <a href="faq.html#offlineLinks">FAQ</a> for more details.</p>
</td>
</tr>
<tr>
@@ -293,15 +285,6 @@
</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.version</td>
<td>Yes</td>
<td>
@@ -314,7 +297,7 @@
<td>maven.javadoc.windowtitle</td>
<td>Yes</td>
<td>
- Specifies the window title to use for the generated
+ Specifies the window title and the doc title to use for the generated
Javadocs. The default value is
<code>${pom.name} ${pom.currentVersion} API</code>.
<code>${pom.name}</code> and <code>${maven.currentVersion}</code>
@@ -344,18 +327,18 @@
<td>maven.docs.outputencoding</td>
<td>Yes</td>
<td>
- The character encoding for generated documentation.
+ The character encoding for generated documentation. This value is used as charset and docencoding for the standard doclet.
</td>
</tr>
<tr>
<td>Project descriptor</td>
<td>pom.package</td>
- <td>Yes</td>
+ <td nowrap="nowrap">No (<= 1.6)<br/><b>Yes (>= 1.7)</b></td>
<td>
The package used as root for the javadoc.
</td>
- </tr>
+ </tr>
</table>
- </section>
+ </section>
</body>
-</document>
\ No newline at end of file
+</document>
1.1 maven-plugins/javadoc/xdocs/faq.fml
Index: faq.fml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Copyright 2001-2004 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<faqs title="Frequently Asked Questions">
<part id="usage">
<title>Plugin Usage</title>
<faq id="links">
<question>How do I use links ?</question>
<answer>
<p>The URLs must link to a directory where the javadoc generated file "package-list" is accesible for the package.</p>
<p>Example:</p>
<source>
maven.javadoc.links=http://java.sun.com/j2se/1.4.2/docs/api/, http://maven.apache.org/apidocs/
</source>
</answer>
</faq>
<faq id="offlineLinks">
<question>How do I use offlineLinks ?</question>
<answer>
<p>The URLs must link to a directory where the javadoc generated file "package-list" is accesible for the package.</p>
<p>Example (generates <b>offline</b> links in offline mode):</p>
<source>
maven.javadoc.offlineLinks=/opt/java-apidoc/j2sdk1.4.1/docs/api/, /cvsroot/maven/target/docs/apidocs/
</source>
<p>Generation of online javadoc links in offline mode is also possible. You need to provide the online URL plus the a offline directory resource for "package-list". URL and directory need to be seperated by the "#" character.</p>
<p>Example (generates <b>online</b> links in offline mode):</p>
<source>
maven.javadoc.offlineLinks= \
http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-apidoc/j2sdk1.4.1/docs/api/, \
http://maven.apache.org/apidocs/#/cvsroot/maven/target/docs/apidocs/
</source>
</answer>
</faq>
<faq id="firewall">
<question>How do I use links behind a Firewall ?</question>
<answer>
<p>You can set your proxy parameters in the additionnal parameters passed to the javadoc :</p>
<source>maven.javadoc.additionalparam=-J-DproxyHost=${maven.proxy.host} -J-DproxyPort=${maven.proxy.port}</source>
</answer>
</faq>
</part>
</faqs>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org