From cf45710a0c95e975e33be4f7156598d2754eddc4 Mon Sep 17 00:00:00 2001 From: aheritier Date: Sun, 26 Sep 2004 13:51:04 +0000 Subject: [PATCH] docs improvement git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@116082 13f79535-47bb-0310-9956-ffa450edef68 --- javadoc/xdocs/faq.fml | 57 ++++++++ javadoc/xdocs/navigation.xml | 17 +-- javadoc/xdocs/properties.xml | 267 ++++++++++++++++------------------- 3 files changed, 191 insertions(+), 150 deletions(-) create mode 100644 javadoc/xdocs/faq.fml diff --git a/javadoc/xdocs/faq.fml b/javadoc/xdocs/faq.fml new file mode 100644 index 00000000..57fbeb3a --- /dev/null +++ b/javadoc/xdocs/faq.fml @@ -0,0 +1,57 @@ + + + + + Plugin Usage + + How do I use links ? + +

The URLs must link to a directory where the javadoc generated file "package-list" is accesible for the package.

+

Example:

+ +maven.javadoc.links=http://java.sun.com/j2se/1.4.2/docs/api/, http://maven.apache.org/apidocs/ + + + + + How do I use offlineLinks ? + +

The URLs must link to a directory where the javadoc generated file "package-list" is accesible for the package.

+

Example (generates offline links in offline mode):

+ +maven.javadoc.offlineLinks=/opt/java-apidoc/j2sdk1.4.1/docs/api/, /cvsroot/maven/target/docs/apidocs/ + +

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.

+

Example (generates online links in offline mode):

+ +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/ + + + + + How do I use links behind a Firewall ? + +

You can set your proxy parameters in the additionnal parameters passed to the javadoc :

+ maven.javadoc.additionalparam=-J-DproxyHost=${maven.proxy.host} -J-DproxyPort=${maven.proxy.port} + + + + \ No newline at end of file diff --git a/javadoc/xdocs/navigation.xml b/javadoc/xdocs/navigation.xml index d83b6468..d45659e3 100644 --- a/javadoc/xdocs/navigation.xml +++ b/javadoc/xdocs/navigation.xml @@ -16,19 +16,20 @@ * limitations under the License. */ --> - - Maven Javadoc Plugin - - - + + - - + + + + + + - \ No newline at end of file + diff --git a/javadoc/xdocs/properties.xml b/javadoc/xdocs/properties.xml index 76078de1..44d05c19 100644 --- a/javadoc/xdocs/properties.xml +++ b/javadoc/xdocs/properties.xml @@ -20,6 +20,7 @@ Javadoc Properties Stéphane MOR + Arnaud HERITIER
@@ -34,53 +35,8 @@ Yes Specifies additional parameters added to the javadoc command line. -

Example (sets generated Javadocs encoding to utf-8):

- -maven.javadoc.additionalparam=-charset utf-8 - - - - - maven.javadoc.author - Yes - - Boolean value. - Specifies whether or not the @author text is - included in the generated Javadocs. - The default value is true. - - - - maven.javadoc.bottom - Yes - - Specifies the text to be placed at the bottom of each output file. The default value is - Copyright ${year} ${pom.organization.name}. All Rights Reserved. - ${pom.organization.name} - expand to value obtained from the project descriptor. - - - - maven.javadoc.customtags - Yes - - 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 : - +

Example (to print what version of javadoc you are using):

+ maven.javadoc.additionalparam=-J-showversion @@ -91,15 +47,6 @@ tag2.scope=all The default value is false. - - maven.javadoc.destdir - Yes - - The destination directory for all of the generated - Javadocs. The default value is - ${maven.docs.dest}/apidocs. - - maven.javadoc.doclet Yes @@ -126,26 +73,6 @@ tag2.scope=all Comma separated list of packages to exclude from the javadoc. - - maven.javadoc.links - Yes - -

- Comma separated list of URLs to create links to javadoc output of - other packages in online mode (see properties maven.online.mode and - maven.javadoc.mode.online). - Works like the "-link" option of the javadoc command. -

-

- The URLs must link to a directory where the javadoc generated file - "package-list" is accesible for the package. -

-

Example:

- -maven.javadoc.links=http://java.sun.com/j2se/1.4.2/docs/api/, http://maven.apache.org/apidocs/ - - - maven.javadoc.locale Yes @@ -165,6 +92,121 @@ maven.javadoc.links=http://java.sun.com/j2se/1.4.2/docs/api/, http://maven.apach the -Xmx parameter. + + maven.javadoc.overview + Yes + + 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. + + + + + maven.javadoc.public
+ maven.javadoc.package
+ maven.javadoc.private + + Yes + + Boolean value. + The scope of classes and members to include in the javadoc. + A true value includes that scope and higher. + The default value is to include protected scope and higher. + + + + maven.javadoc.source + Yes + + Specifies the version of the jdk in use. See + the + ant javadoc task documentation for more detail. + + + + maven.javadoc.useexternalfile + Yes + + 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. + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - @@ -292,15 +284,6 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap The default value is true. - - - - - @@ -314,7 +297,7 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap - + - +
PropertyOptional?Description
maven.javadoc.authorYes + Boolean value. + Specifies whether or not the @author text is + included in the generated Javadocs. + The default value is true. +
maven.javadoc.bottomYes + Specifies the text to be placed at the bottom of each output file. The default value is + Copyright ${year} ${pom.organization.name}. All Rights Reserved. + ${pom.organization.name} + expand to value obtained from the project descriptor. +
maven.javadoc.customtagsYes + 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 : + +
maven.javadoc.destdirYes + The destination directory for all of the generated + Javadocs. The default value is + ${maven.docs.dest}/apidocs. +
maven.javadoc.linksYes +

+ Comma separated list of URLs to create links to javadoc output of + other packages in online mode (see properties maven.online.mode and + maven.javadoc.mode.online). + Works like the "-link" option of the javadoc command. +

+

See the FAQ for more details.

+
maven.javadoc.mode.online @@ -198,57 +240,7 @@ maven.javadoc.links=http://java.sun.com/j2se/1.4.2/docs/api/, http://maven.apach maven.javadoc.mode.online). Works like the "-linkoffline" option of the javadoc command.

-

- The URLs must link to a directory where the javadoc generated file - "package-list" is accesible for the package. -

-

Example (generates offline links in offline mode):

- -maven.javadoc.offlineLinks=/opt/java-apidoc/j2sdk1.4.1/docs/api/, /cvsroot/maven/target/docs/apidocs/ - -

- 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. -

-

Example (generates online links in offline mode):

- -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/ - -
maven.javadoc.overviewYes - 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. -
- maven.javadoc.public
- maven.javadoc.package
- maven.javadoc.private - 		Yes - Boolean value. - The scope of classes and members to include in the javadoc. - A true value includes that scope and higher. - The default value is to include protected scope and higher. -
maven.javadoc.sourceYes - Specifies the version of the jdk in use. See - the - ant javadoc task documentation for more detail. +

See the FAQ for more details.
maven.javadoc.useexternalfileYes - 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. -
maven.javadoc.version Yesmaven.javadoc.windowtitle Yes - 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 ${pom.name} ${pom.currentVersion} API. ${pom.name} and ${maven.currentVersion} @@ -344,18 +327,18 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap maven.docs.outputencoding Yes - The character encoding for generated documentation. + The character encoding for generated documentation. This value is used as charset and docencoding for the standard doclet.
Project descriptor pom.packageYesNo (<= 1.6)
Yes (>= 1.7)		 The package used as root for the javadoc.
-
+ - \ No newline at end of file +