diff --git a/javadoc/plugin.properties b/javadoc/plugin.properties index c28baa96..58936fcd 100644 --- a/javadoc/plugin.properties +++ b/javadoc/plugin.properties @@ -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 = -#maven.javadoc.maxmemory -maven.javadoc.public = false -maven.javadoc.package = true -maven.javadoc.private = false -maven.javadoc.stylesheet = ${plugin.resources}/stylesheet.css -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.maxmemory + +#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.useexternalfile = yes +maven.javadoc.version = true +maven.javadoc.windowtitle = ${pom.name} ${pom.currentVersion} API \ No newline at end of file diff --git a/javadoc/xdocs/properties.xml b/javadoc/xdocs/properties.xml index 60270dcb..d537a30e 100644 --- a/javadoc/xdocs/properties.xml +++ b/javadoc/xdocs/properties.xml @@ -16,18 +16,30 @@ * limitations under the License. */ --> - - Javadoc Properties Stéphane MOR - -
+
- + + + + + + + + + + @@ -38,6 +50,29 @@ The default value is true. + + + + + @@ -66,17 +101,6 @@ ant javadoc task documentation for more detail. - - - - - @@ -108,7 +132,18 @@ maven.javadoc.links=http://java.sun.com/j2se/1.4.2/docs/api/, http://maven.apach - + + + + + + + + + + + @@ -173,24 +217,6 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap The default value is to include protected scope and higher. - - - - - - - - - - @@ -200,6 +226,26 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap ant javadoc task documentation for more detail. + + + + + + + + + + @@ -212,16 +258,6 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap ant javadoc task documentation for more detail. - - - - - @@ -231,6 +267,15 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap The default value is true. + + + + + @@ -251,50 +296,6 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap expand to values obtained from the project descriptor. - - - - - - - - - - - - - - -
PropertyOptional?Description
PropertyOptional?Description
maven.javadoc.additionalparamYes + 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
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.destdir Yes
maven.javadoc.doctitleYes - Specifies the document title to use for the generated - Javadocs. The default value is ${maven.name} - ${maven.currentVersion} API. ${maven.name} - and ${maven.currentVersion} expand to values obtained - from the project descriptor. -
maven.javadoc.links Yes
maven.javadoc.mode.onlinemaven.javadoc.maxmemoryYes + Specifies the maximum Java heap size to be used when launching + the javadoc executable. Some JVMs refer to this property as + the -Xmx parameter. +
+ maven.javadoc.mode.online + Yes

@@ -160,9 +195,18 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap

maven.javadoc.overviewYes - maven.javadoc.public
- maven.javadoc.package
+ 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
maven.javadoc.maxmemoryYes - Specifies the maximum Java heap size to be used when launching - the javadoc executable. Some JVMs refer to this property as - the -Xmx parameter. -
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.source Yes
maven.javadoc.stylesheetYes + Specifies the stylesheet file to use for the javadoc. + Default is ${plugin.resources}/stylesheet.css +
+ maven.javadoc.tagletpath + Yes + Specifies the path to the taglet classes when calling javadoc + with taglets. See + the + ant javadoc task documentation for more detail. +
maven.javadoc.taglets Yes
maven.javadoc.tagletpathYes - Specifies the path to the taglet classes when calling javadoc - with taglets. See - the - ant javadoc task documentation for more detail. -
maven.javadoc.use Yes
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 Yes
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.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.additionalparamYes - Specifies additional parameters added to the javadoc command line. -

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

- -maven.javadoc.additionalparam=-charset utf-8 - -