Obtained from: Submitted by: Reviewed by: CVS: ---------------------------------------------------------------------- CVS: PR: CVS: If this change addresses a PR in the problem report tracking CVS: database, then enter the PR number(s) here. CVS: Obtained from: CVS: If this change has been taken from another system, such as NCSA, CVS: then name the system in this line, otherwise delete it. CVS: Submitted by: CVS: If this code has been contributed to Apache by someone else; i.e., CVS: they sent us a patch or a new module, then include their name/email CVS: address here. If this is your work then delete this line. CVS: Reviewed by: CVS: If we are doing pre-commit code reviews and someone else has CVS: reviewed your changes, include their name(s) here. CVS: If you have not had it reviewed then delete this line. git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114793 13f79535-47bb-0310-9956-ffa450edef68
48 lines
1.6 KiB
XML
48 lines
1.6 KiB
XML
<?xml version="1.0"?>
|
|
<!--
|
|
/*
|
|
* Copyright 2001-2004 The Apache Software Foundation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
-->
|
|
|
|
<document>
|
|
|
|
<properties>
|
|
<title>Maven Javadoc Plug-in</title>
|
|
<author email="jason@zenplex.com">Jason van Zyl</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="Maven Javadoc Plug-in">
|
|
<p>
|
|
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 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>
|
|
</document>
|