------ Usage ------ Vincent Siveton Maria Odea Ching ------ 27 June 2006 ------ ~~ Copyright 2006 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. ~~ NOTE: For help with the syntax of this file, see: ~~ http://maven.apache.org/guides/mini/guide-apt-format.html Usage The Javadoc Plugin generates javadocs using the Javadoc tool. The following examples describe the basic usage of the Plugin. * Generate Javadocs As Part of Project Reports To generate javadocs as part of the site generation, you must configure the following in the \ section of your pom: +-----+ ... org.apache.maven.plugins maven-javadoc-plugin ... ... +-----+ When you execute <<>>, the javadocs will be generated and included in the generated site. A link to the javadocs will be added in the Project Reports menu. * Generate Standalone Javadocs To generate standalone javadocs for the project, you can execute any of the following commands: +-----+ mvn javadoc:javadoc +-----+ or +-----+ mvn javadoc:jar +-----+ For <<>>, the javadocs are first generated and then packaged into a jar file. * Javadoc Configuration The Javadoc Plugin supports a large number of configuration parameters. Please see the {{{javadoc-mojo.html}javadoc:javadoc}} goal documentation for a listing of these parameters. Most of these parameters are passed directly to the javadoc tool itself. More info on the Javadoc tool can be found {{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html}here}}.