Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Apply MPJAVADOC-17

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114565 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
dion 2004-01-07 01:20:19 +00:00
parent 1a565ab4e0
commit 7835460f41
4 changed files with 36 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
javadoc/plugin.jelly
View File

@ -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"

3
javadoc/xdocs/changes.xml
View File

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

16
javadoc/xdocs/index.xml
View File

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

28
javadoc/xdocs/properties.xml
View File

@ -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 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap
</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 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap
<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 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap
<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>