From e35a77a50eb0f3163ae0efe92adb3c0bb7933ae8 Mon Sep 17 00:00:00 2001 From: jjensen Date: Sat, 21 Apr 2007 15:45:38 +0000 Subject: [PATCH] Add Default column and move values there for ease of seeing them. git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@531052 13f79535-47bb-0310-9956-ffa450edef68 --- javadoc/xdocs/properties.xml | 71 +++++++++++++++++++++++------------- 1 file changed, 46 insertions(+), 25 deletions(-) diff --git a/javadoc/xdocs/properties.xml b/javadoc/xdocs/properties.xml index 38079d72..942caa64 100644 --- a/javadoc/xdocs/properties.xml +++ b/javadoc/xdocs/properties.xml @@ -29,6 +29,7 @@ Property Optional? Description + Default maven.javadoc.additionalparam @@ -38,6 +39,7 @@

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

maven.javadoc.additionalparam=-J-showversion + (none) maven.javadoc.extrasourcepath @@ -47,14 +49,15 @@ to the sourcepath parameter of the ant javadoc task. This can be used to add paths for inherited javadocs. + (none) maven.javadoc.debug Yes Print informations to debug the plugin. - The default value is false. + false maven.javadoc.excludepackagenames @@ -62,6 +65,7 @@ Comma separated list of packages to exclude from the javadoc. + (none) maven.javadoc.locale @@ -72,6 +76,7 @@ Works like the "-locale" option of the javadoc command.

+ (none) maven.javadoc.maxmemory @@ -79,8 +84,9 @@ Specifies the maximum Java heap size to be used when launching the javadoc executable. Some JVMs refer to this property as - the -Xmx parameter. Defaults to 512m. + the -Xmx parameter. + 512m maven.javadoc.overview @@ -90,6 +96,7 @@ Add additional overview documentation to the overview page of the javadoc. The documentation must be an HTML file, specified relative to the project.xml. + (none) @@ -102,8 +109,8 @@ 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. + protected scope and higher maven.javadoc.source @@ -113,6 +120,7 @@ the ant javadoc task documentation for more detail. + (none) maven.javadoc.useexternalfile @@ -120,30 +128,34 @@ 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. + the command line shorter. + no maven.javadoc.failonerror Yes Stop the buildprocess if the command exits with a returncode other - than 0. Default value : false. + than 0. + false maven.javadoc.javadocreport Yes - Include the javadoc report. Default value: true. + Include the javadoc report. + true maven.javadoc.warningsreport Yes - Include the javadoc warnings report. Default value: true. + Include the javadoc warnings report. + true @@ -153,6 +165,7 @@ Property Optional? Description + Default maven.javadoc.author @@ -161,17 +174,19 @@ Boolean value. Specifies whether or not the @author text is included in the generated Javadocs. - The default value is true. + 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. + Specifies the text to be placed at the bottom of each output file. ${pom.organization.name} - expand to value obtained from the project descriptor. + expands to value obtained from the project descriptor. + + + Copyright ${year} ${pom.organization.name}. All Rights Reserved. @@ -197,33 +212,37 @@ tag2.scope=all]]> Note: Due to a bug in the jexl expression evaluator, custom tag names defined by this property cannot contain dashes. + (none) maven.javadoc.destdir Yes The destination directory for all of the generated - Javadocs. The default value is - ${maven.docs.dest}/apidocs. + Javadocs. + ${maven.docs.dest}/apidocs maven.javadoc.footer Yes Specifies the text or html fragment to be placed to the right of the bottom navigation bar - on all pages. The default is to not have a footer. If the footer is not set, - but the header is, then Javadoc will user the header in both places. + on all pages. + If the footer is not set, + but the header is, then Javadoc will use the header in both places. + (none) maven.javadoc.header Yes Specifies the text or html fragment to be placed at the top of the navigation frame in the upper-left corner, - and to the right of the top navigation bar on all pages. The default is to not have a header. + and to the right of the top navigation bar on all pages. Javadoc will be use this as the footer as well if the footer is not set explicitly. + (none) maven.javadoc.links @@ -237,6 +256,7 @@ tag2.scope=all]]>

See the FAQ for more details.

+ (none) @@ -244,9 +264,6 @@ tag2.scope=all]]> Yes -

- Default value is ${maven.mode.online}. -

If set, a value of true forces generation of javadoc in online mode (using ${maven.javadoc.links}). @@ -260,6 +277,7 @@ tag2.scope=all]]> "general" online/offline mode ${maven.mode.online}.

+ ${maven.mode.online} maven.javadoc.offlineLinks @@ -273,14 +291,15 @@ tag2.scope=all]]>

See the FAQ for more details.

+ (none) maven.javadoc.stylesheet Yes Specifies the stylesheet file to use for the javadoc. - Default is ${plugin.resources}/stylesheet.css + ${plugin.resources}/stylesheet.css @@ -293,6 +312,7 @@ tag2.scope=all]]> the ant javadoc task documentation for more detail. + (none) maven.javadoc.taglets @@ -305,6 +325,7 @@ tag2.scope=all]]> See the ant javadoc task documentation for more detail. + (none) maven.javadoc.use @@ -312,28 +333,28 @@ tag2.scope=all]]> Boolean value. If true, a "use" page is generated for each class and member. - The default value is true. + true maven.javadoc.version Yes Specifies whether or not the @version text is - included in the generated Javadocs. The default value is - true. + included in the generated Javadocs. + true maven.javadoc.windowtitle Yes Specifies the window title and the doc title to use for the generated - Javadocs. The default value is - ${pom.name} ${pom.currentVersion} API. + Javadocs. ${pom.name} and ${maven.currentVersion} expand to values obtained from the project descriptor. + ${pom.name} ${pom.currentVersion} API