dion 2004/01/06 17:20:19
Modified: javadoc/xdocs changes.xml properties.xml index.xml
javadoc plugin.jelly
Log:
Apply MPJAVADOC-17
Revision Changes Path
1.17 +3 -0 maven-plugins/javadoc/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/maven-plugins/javadoc/xdocs/changes.xml,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- changes.xml 7 Jan 2004 00:00:55 -0000 1.16
+++ changes.xml 7 Jan 2004 01:20:19 -0000 1.17
@@ -9,6 +9,9 @@
<body>
<release version="1.4" date="in CVS">
+ <action dev="dion" type="update">
+ Apply MPJAVADOC-17.
+ </action>
<action dev="jvanzyl" type="update">
Remove the need for ${pom} interpolation in properties. The
use of the maven:property tag is now used to glean a default property.
1.12 +18 -10 maven-plugins/javadoc/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/maven-plugins/javadoc/xdocs/properties.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- properties.xml 8 Oct 2003 16:38:11 -0000 1.11
+++ properties.xml 7 Jan 2004 01:20:19 -0000 1.12
@@ -14,9 +14,10 @@
<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>.
+ included in the generated Javadocs.
+ The default value is <code>true</code>.
</td>
</tr>
<tr>
@@ -141,12 +142,17 @@
</td>
</tr>
<tr>
- <td>maven.javadoc.private</td>
+ <td>
+ maven.javadoc.public<br />
+ maven.javadoc.package<br />
+ maven.javadoc.private
+ </td>
<td>Yes</td>
<td>
- Specifies whether or not all classes and members are
- included in the generated Javadocs. The default value is
- <code>false</code>.
+ 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>
@@ -162,7 +168,9 @@
<td>maven.javadoc.overview</td>
<td>Yes</td>
<td>
- 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.
</td>
</tr>
<tr>
@@ -200,9 +208,9 @@
<td>maven.javadoc.use</td>
<td>Yes</td>
<td>
- Specifies whether or not a "use" page is generated for
- each class and member. The default value is
- <code>true</code>.
+ Boolean value.
+ If <code>true</code>, a "use" page is generated for each class and
member.
+ The default value is <code>true</code>.
</td>
</tr>
<tr>
1.2 +12 -4 maven-plugins/javadoc/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/maven-plugins/javadoc/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 24 Jan 2003 03:45:34 -0000 1.1
+++ index.xml 7 Jan 2004 01:20:19 -0000 1.2
@@ -9,12 +9,20 @@
<body>
<section name="Maven Javadoc Plug-in">
<p>
- This plug-in provides your basic Javadoc reporting via the
- <code>javadoc</code> goal as described <a href="goals.html">here</a>.
+ Generates documentation for the Java code in the project using the
+ standard <a href="http://java.sun.com/j2se/javadoc/";>Javadoc</a> tool.
+ The default settings will suit many projects, and simply entering
+ <code>maven javadoc</code> will create the standard documentation.
</p>
<p>
- The properties that allow you to customize the execution of
- java are documented <a href="properties.html">here</a>.
+ The Javadoc plug-in provides a number of <a href="goals.html">goals</a>.
+ The main goal generates the Javadoc, while a number of subsidiary goals
+ distribute the results as a jar file.
+ </p>
+ <p>
+ The standard settings for the plug-in are suitable for many uses.
+ A full range of <a href="properties.html">properties</a> is also
+ provided for further customisation.
</p>
</section>
</body>
1.27 +3 -3 maven-plugins/javadoc/plugin.jelly
Index: plugin.jelly
===================================================================
RCS file: /home/cvs/maven-plugins/javadoc/plugin.jelly,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -r1.26 -r1.27
--- plugin.jelly 9 Nov 2003 16:11:34 -0000 1.26
+++ plugin.jelly 7 Jan 2004 01:20:19 -0000 1.27
@@ -221,7 +221,7 @@
<!--==================================================================-->
- <!-- Install the war in the local repository -->
+ <!-- Create a jar file containing the javadoc -->
<!--==================================================================-->
<goal name="javadoc:jar" prereqs="javadoc">
<j:set var="maven.javadoc.final.name"
@@ -234,7 +234,7 @@
</goal>
<!--==================================================================-->
- <!-- Install the war in the local repository -->
+ <!-- Install the jar in the local repository -->
<!--==================================================================-->
<goal name="javadoc:install"
prereqs="javadoc:jar"
@@ -248,7 +248,7 @@
</goal>
<!--==================================================================-->
- <!-- Install the snapshot version of the war in the local repository -->
+ <!-- Install the snapshot version of the jar in the local repository -->
<!--==================================================================-->
<goal name="javadoc:install-snapshot"
prereqs="javadoc:jar"
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
