Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs improvement

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@116082 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
aheritier
2004-09-26 13:51:04 +00:00
parent 50036ba6fa
commit cf45710a0c
3 changed files with 191 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
javadoc/xdocs/faq.fml Normal file
View File

@@ -0,0 +1,57 @@
<?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>

17
javadoc/xdocs/navigation.xml
View File

@@ -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>
</project>

267
javadoc/xdocs/properties.xml
View File

@@ -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,53 +35,8 @@
<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>
<td>
Boolean value.
Specifies whether or not the <code>@author</code> text is
included in the generated Javadocs.
The default value is <code>true</code>.
</td>
</tr>
<tr>
<td>maven.javadoc.bottom</td>
<td>Yes</td>
<td>
Specifies the text to be placed at the bottom of each output file. The default value is
<source>Copyright ${year} ${pom.organization.name}. All Rights Reserved.</source>
<code>${pom.organization.name}</code>
expand to value obtained from the project descriptor.
</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>
<p>Example (to print what version of javadoc you are using):</p>
<source>maven.javadoc.additionalparam=-J-showversion</source>
</td>
</tr>
<tr>
@@ -91,15 +47,6 @@ tag2.scope=all
The default value is <code>false</code>.
</td>
</tr>
<tr>
<td>maven.javadoc.destdir</td>
<td>Yes</td>
<td>
The destination directory for all of the generated
Javadocs. The default value is
<code>${maven.docs.dest}/apidocs</code>.
</td>
</tr>
<tr>
<td>maven.javadoc.doclet</td>
<td>Yes</td>
@@ -126,26 +73,6 @@ tag2.scope=all
Comma separated list of packages to exclude from the javadoc.
</td>
</tr>
<tr>
<td>maven.javadoc.links</td>
<td>Yes</td>
<td>
<p>
Comma separated list of URLs to create links to javadoc output of
other packages in online mode (see properties maven.online.mode and
<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>
@@ -165,6 +92,121 @@ maven.javadoc.links=http://java.sun.com/j2se/1.4.2/docs/api/, http://maven.apach
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>
Boolean value.
Specifies whether or not the <code>@author</code> text is
included in the generated Javadocs.
The default value is <code>true</code>.
</td>
</tr>
<tr>
<td>maven.javadoc.bottom</td>
<td>Yes</td>
<td>
Specifies the text to be placed at the bottom of each output file. The default value is
<source>Copyright ${year} ${pom.organization.name}. All Rights Reserved.</source>
<code>${pom.organization.name}</code>
expand to value obtained from the project descriptor.
</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>
The destination directory for all of the generated
Javadocs. The default value is
<code>${maven.docs.dest}/apidocs</code>.
</td>
</tr>
<tr>
<td>maven.javadoc.links</td>
<td>Yes</td>
<td>
<p>
Comma separated list of URLs to create links to javadoc output of
other packages in online mode (see properties maven.online.mode and
<a href="#maven.javadoc.mode.online">maven.javadoc.mode.online</a>).
Works like the "-link" option of the javadoc command.
</p>
<p>See the <a href="faq.html#links">FAQ</a> for more details.</p>
</td>
</tr>
<tr>
<td>
<a name="maven.javadoc.mode.online">maven.javadoc.mode.online</a>
@@ -198,57 +240,7 @@ maven.javadoc.links=http://java.sun.com/j2se/1.4.2/docs/api/, http://maven.apach
<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>
@@ -292,15 +284,6 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap
The default value is <code>true</code>.
</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>
@@ -314,7 +297,7 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap
<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 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap
<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 (&lt;= 1.6)<br/><b>Yes (&gt;= 1.7)</b></td>
<td>
The package used as root for the javadoc.
</td>
</tr>
</tr>
</table>
</section>
</section>
</body>
</document>
</document>