diff --git a/javadoc/plugin.jelly b/javadoc/plugin.jelly index 10fde180..1ea59eab 100644 --- a/javadoc/plugin.jelly +++ b/javadoc/plugin.jelly @@ -221,7 +221,7 @@ - + - + - + + + Apply MPJAVADOC-17. + Remove the need for ${pom} interpolation in properties. The use of the maven:property tag is now used to glean a default property. diff --git a/javadoc/xdocs/index.xml b/javadoc/xdocs/index.xml index 05fa1a06..1b5018ad 100644 --- a/javadoc/xdocs/index.xml +++ b/javadoc/xdocs/index.xml @@ -9,12 +9,20 @@

- This plug-in provides your basic Javadoc reporting via the - javadoc goal as described here. + Generates documentation for the Java code in the project using the + standard Javadoc tool. + The default settings will suit many projects, and simply entering + maven javadoc will create the standard documentation.

- The properties that allow you to customize the execution of - java are documented here. + The Javadoc plug-in provides a number of goals. + The main goal generates the Javadoc, while a number of subsidiary goals + distribute the results as a jar file. +

+

+ The standard settings for the plug-in are suitable for many uses. + A full range of properties is also + provided for further customisation.

diff --git a/javadoc/xdocs/properties.xml b/javadoc/xdocs/properties.xml index bb34e536..bcab7950 100644 --- a/javadoc/xdocs/properties.xml +++ b/javadoc/xdocs/properties.xml @@ -14,9 +14,10 @@ maven.javadoc.author Yes + Boolean value. Specifies whether or not the @author text is - included in the generated Javadocs. The default value is - true. + included in the generated Javadocs. + The default value is true. @@ -141,12 +142,17 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap - maven.javadoc.private + + maven.javadoc.public
+ maven.javadoc.package
+ maven.javadoc.private + Yes - Specifies whether or not all classes and members are - included in the generated Javadocs. The default value is - false. + 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. @@ -162,7 +168,9 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap maven.javadoc.overview Yes - Read overview documentation from HTML file. + 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. @@ -200,9 +208,9 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap maven.javadoc.use Yes - Specifies whether or not a "use" page is generated for - each class and member. The default value is - true. + Boolean value. + If true, a "use" page is generated for each class and member. + The default value is true.