Author: vsiveton
Date: Fri Sep 11 12:44:39 2009
New Revision: 813811
URL: http://svn.apache.org/viewvc?rev=813811&view=rev
Log:
o added link to plugin documentation for each parameter
o formatting doc
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-doclet.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-javadoc-tool.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/exclude-package-names.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/fix-javadocs.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/help-configuration.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/links-configuration.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/selective-javadocs-report.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/taglet-configuration.apt.vm
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/test-javadocs.apt.vm
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate.apt.vm?rev=813811&r1=813810&r2=813811&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate.apt.vm
Fri Sep 11 12:44:39 2009
@@ -46,9 +46,11 @@
* Using The \<aggregate/\> Parameter (<<deprecated>>)
- <<Note>>: \<aggregate/\> parameter is <<deprecated>> since 2.5. Please use
the <<<aggregate>>> goal instead of.
+ <<Note>>: {{{../javadoc-mojo.html#aggregate}\<aggregate/\>}} parameter is
<<deprecated>> since 2.5. Please use the
+ <<<aggregate>>> goal instead of.
- The \<aggregate/\> parameter can be used to generate javadocs for
multi-module projects. It gives the option to
+ The {{{../javadoc-mojo.html#aggregate}\<aggregate/\>}} parameter can be used
to generate javadocs for multi-module
+ projects. It gives the option to
generate one javadoc report for the entire project (all modules) or generate
one javadoc report for each module.
When you execute javadoc:javadoc from Project directory with aggregate set to
<<true>>, a javadoc report will be created
@@ -60,7 +62,7 @@
+-----+
<project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -74,17 +76,17 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
+-----+
* Using The <<<aggregate>>> Goals
- The \<aggregate/\> parameter doesn't include generate source directories
defined using the
-
{{{http://mojo.codehaus.org/build-helper-maven-plugin/add-source-mojo.html}build-helper:add-source}}.
In this case,
- you need to use the <<<aggregate>>> goal and <<<test-aggregate>>> goals. You
could also define several \<reportSet/\>
- like the following:
+ The {{{../javadoc-mojo.html#aggregate}\<aggregate/\>}} parameter doesn't
include generate source directories defined
+ using the
{{{http://mojo.codehaus.org/build-helper-maven-plugin/add-source-mojo.html}build-helper:add-source}}.
In
+ this case, you need to use the <<<aggregate>>> goal and <<<test-aggregate>>>
goals. You could also define several
+ \<reportSet/\> like the following:
+-----+
@@ -123,8 +125,8 @@
</project>
+-----+
- The Javadoc plugin contains several <<<aggregate>>> goals to be use with an
aggregator project. Here is the full list of all
- <<<aggregate>>> goals:
+ The Javadoc plugin contains several <<<aggregate>>> goals to be use with an
aggregator project. Here is the full list
+ of all <<<aggregate>>> goals:
* {{{../aggregate-mojo.html}javadoc:aggregate}} to generate the Javadoc
files.
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-doclet.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-doclet.apt.vm?rev=813811&r1=813810&r2=813811&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-doclet.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-doclet.apt.vm
Fri Sep 11 12:44:39 2009
@@ -31,14 +31,16 @@
To generate output from an alternate doclet, add configuration similar to the
following to your POM.
- In this example, the doclet is UmlGraph. UmlGraph allows the declarative
specification and drawing
- of UML class and sequence diagrams.
- For more information about UmlGraph, please refer to
{{http://www.umlgraph.org/}}.
+ In this example, the doclet is UmlGraph ({{http://www.umlgraph.org/}}).
UmlGraph allows the declarative specification
+ and drawing of UML class and sequence diagrams.
+
+ <<Note about UmlGraph>>: You must have the Graphviz binary in your PATH, or
the images will not be generated.
+ For more information about Graphviz, please refer to
{{http://www.graphviz.org/}}.
+-----+
<project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -59,38 +61,34 @@
</plugin>
...
</plugins>
- </reporting>
+ </reporting> (or </build>)
...
</project>
+-----+
<<Note>>:
- * \<additionalparam/\> is used to set additional parameters on the command
line, specifically
- for doclet options.
+ * {{{../javadoc-mojo.html#additionalparam}\<additionalparam/\>}} is used to
set additional parameters on the command
+ line, specifically for doclet options.
- * \<useStandardDocletOptions/\> uses the
+ *
{{{../javadoc-mojo.html#useStandardDocletOptions}\<useStandardDocletOptions/\>}}
uses the
{{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#standard}options
provided by the Standard Doclet}}.
- * If you need more artifacts in the docletpath, you could use
\<docletArtifacts/\>.
+ * If you need more artifacts in the docletpath, you could use
{{{../javadoc-mojo.html#docletArtifacts}\<docletArtifacts/\>}}.
[]
After executing <<<mvn site>>>, you will see that a UML graph (.dot file)
will be generated in the
destination directory.
- <<Note about UmlGraph>>: You must have the Graphviz binary in your PATH, or
the images will not be generated.
- For more information about Graphviz, please refer to
{{http://www.graphviz.org/}}.
-
Using Alternate Doclet In Addition To The Javadoc Doclet
To generate output from an alternate doclet in addition to the normal HTML
Javadoc doclet, add configuration
similar to the following to your POM.
- In this example, the doclet is Sun DocCheck. The Sun Doc Check Doclet is an
extension to the Javadoc
- tool. It runs on source code and reviews documentation comments, generating
an HTML report that
- identifies empty comments and other ommissions and irregularities in the
documentation comments.
- For more information about Sun DocCheck, please refer to
{{http://java.sun.com/j2se/javadoc/doccheck/}}.
+ In this example, the doclet is Sun DocCheck
({{http://java.sun.com/j2se/javadoc/doccheck/}}). The Sun Doc Check Doclet
+ is an extension to the Javadoc tool. It runs on source code and reviews
documentation comments, generating an HTML
+ report that identifies empty comments and other ommissions and irregularities
in the documentation comments.
+-----+
<project>
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-javadoc-tool.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-javadoc-tool.apt.vm?rev=813811&r1=813810&r2=813811&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-javadoc-tool.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/alternate-javadoc-tool.apt.vm
Fri Sep 11 12:44:39 2009
@@ -33,12 +33,13 @@
By default, the Maven Javadoc Plugin tries to auto-detect the Javadoc Tool
executable from the Java property
<java.home> or from the environment variable <JAVA_HOME>.
- You could also specify the executable of the Javadoc Tool to use. For example:
+ You could also specify the executable of the Javadoc Tool to use with the
+ {{{../javadoc-mojo.html#javadocExecutable}\<javadocExecutable/\>}} parameter.
For example:
+-----+
<project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -51,7 +52,7 @@
</plugin>
...
</plugins>
- </reporting>
+ </reporting> (or </build>)
...
</project>
+-----+
@@ -66,7 +67,7 @@
+-----+
<project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -79,7 +80,7 @@
</plugin>
...
</plugins>
- </reporting>
+ </reporting> (or </build>)
...
</project>
+-----+
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/exclude-package-names.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/exclude-package-names.apt.vm?rev=813811&r1=813810&r2=813811&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/exclude-package-names.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/exclude-package-names.apt.vm
Fri Sep 11 12:44:39 2009
@@ -3,7 +3,7 @@
------
Maria Odea Ching
------
- 2009-08-04
+ 2009-09-11
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -28,9 +28,10 @@
Excluding Packages
- To exclude specific packages from the javadoc, use \<excludePackageNames\> as
shown below. The parameter
- accepts wildcard (*) characters in its value but the wildcards should either
be at the start or the end of the package
- name. If more than one package is to be excluded, each package name must be
separated either with a ':', ',' or ';'.
+ To exclude specific packages from the Javadoc tool, use
{{{../javadoc-mojo.html#excludePackageNames}\<excludePackageNames/\>}}
+ as shown below. The parameter accepts wildcard (*) characters in its value
but the wildcards should either be at the
+ start or the end of the package name. If more than one package is to be
excluded, each package name must be separated
+ either with a colon (':'), a comma (',') or a semicolon (';').
+-----+
<project>
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/fix-javadocs.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/fix-javadocs.apt.vm?rev=813811&r1=813810&r2=813811&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/fix-javadocs.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/fix-javadocs.apt.vm
Fri Sep 11 12:44:39 2009
@@ -41,15 +41,15 @@
* Features Summary
The user could skip the class/field/method Javadoc fixing using specific
parameters, i.e.
- {{{../fix-mojo.html#fixClassComment}fixClassComment}}.
- Also, the user could specify a {{{../fix-mojo.html#level}level}}, i.e.
public, to fix only class/field/method with
+ {{{../fix-mojo.html#fixClassComment}\<fixClassComment/\>}}.
+ Also, the user could specify a {{{../fix-mojo.html#level}\<level/\>}}, i.e.
public, to fix only class/field/method with
the given level.
- These goals could fix dynamically all Javadoc tags (by default, see
{{{../fix-mojo.html#fixTags}fixTags}}) or
+ These goals could fix dynamically all Javadoc tags (by default, see
{{{../fix-mojo.html#fixTags}\<fixTags/\>}}) or
selective tags like author, version...
- Also, the user could specify default value for some tags, i.e.
{{{../fix-mojo.html#defaultAuthor}defaultAuthor}}.
+ Also, the user could specify default value for some tags, i.e.
{{{../fix-mojo.html#defaultAuthor}\<defaultAuthor/\>}}.
- The <javadoc:fix> goal could use {{{http://clirr.sourceforge.net/}Clirr}} via
the
+ The <javadoc:fix> goal could use Clirr ({{{http://clirr.sourceforge.net}}}
via the
{{{http://mojo.codehaus.org/clirr-maven-plugin/}clirr-maven-plugin}}, a tool
that checks Java libraries for
binary and source compatibility with older releases. So, the <@since> tags
will be dynamically added for the current
project version. You need to add the <comparisonVersion> parameter (see
below).
@@ -107,11 +107,13 @@
** Using another Clirr version
- By default, the <fix> and <test-fix> goals use the
{{{http://mojo.codehaus.org/clirr-maven-plugin/}clirr-maven-plugin}}, version
<<<2.2.2>>>.
- To use another version, you need to add a dependency in the Javadoc plugin,
similar to the following:
+ By default, the <fix> and <test-fix> goals use the
{{{http://mojo.codehaus.org/clirr-maven-plugin/}clirr-maven-plugin}},
+ version <<<2.2.2>>>. To use another version, you need to add a dependency in
the Javadoc plugin, similar to the
+ following:
+-----+
<project>
+ ...
<build>
<plugins>
<plugin>
@@ -128,9 +130,11 @@
<version>2.3-SNAPSHOT</version>
</dependency>
</dependencies>
- ...
</plugin>
+ ...
</plugins>
+ ...
</build>
+ ...
</project>
+-----+
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt.vm?rev=813811&r1=813810&r2=813811&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/group-configuration.apt.vm
Fri Sep 11 12:44:39 2009
@@ -29,12 +29,12 @@
Grouping Packages
- To set a grouping for different packages, use the \<groups/\> configuration
in your pom:
+ To set a grouping for different packages, use the
{{{../javadoc-mojo.html#groups}\<groups/\>}} configuration in your pom:
+-----+
<project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -57,7 +57,7 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
+-----+
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/help-configuration.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/help-configuration.apt.vm?rev=813811&r1=813810&r2=813811&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/help-configuration.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/help-configuration.apt.vm
Fri Sep 11 12:44:39 2009
@@ -28,14 +28,15 @@
Configuring Help File
- If a custom \<helpfile/\> parameter is specified, you will be able to use it:
+ If a custom {{{../javadoc-mojo.html#helpfile}\<helpfile/\>}} parameter is
specified, you will be able to use it:
- * if \<helpfile/\> is a given file, you could use an absolute or a relative
path, for instance:
+ * if {{{../javadoc-mojo.html#helpfile}\<helpfile/\>}} is a given file, you
could use an absolute or a relative path,
+ for instance:
+-----+
<project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -48,34 +49,18 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
+-----+
- * since 2.6, \<helpfile/\> could be a resource in your project directory,
i.e. <<<src/main/java>>>,
- <<<src/main/resources>>> or <<<src/main/javadoc>>>, for instance:
+ * since 2.6, {{{../javadoc-mojo.html#helpfile}\<helpfile/\>}} could be a
resource in your project directory, i.e.
+ <<<src/main/java>>>, <<<src/main/resources>>> or <<<src/main/javadoc>>>, for
instance:
+-----+
<project>
...
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <helpfile>path/to/your/resource/help-doc.html</helpfile>
- ...
- </configuration>
- </plugin>
- </plugins>
- ...
- </build>
- ...
- <!-- Or the following
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -88,13 +73,13 @@
</plugin>
</plugins>
...
- </reporting>
- -->
+ </reporting> (or </build>)
...
</project>
+-----+
- * since 2.6, \<helpfile/\> could be a resource in the Javadoc plugin
dependencies, for instance:
+ * since 2.6, {{{../javadoc-mojo.html#helpfile}\<helpfile/\>}} could be a
resource in the Javadoc plugin dependencies,
+ for instance:
+-----+
<project>
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt.vm?rev=813811&r1=813810&r2=813811&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/javadoc-resources.apt.vm
Fri Sep 11 12:44:39 2009
@@ -28,8 +28,8 @@
Using Javadoc Resources
- The \<javadocDirectory/\> parameter can be used to include Javadoc resources
like HTML or images. By default, all
- javadoc resources are in <$\{basedir\}/src/main/javadoc> directory.
+ The {{{../javadoc-mojo.html#javadocDirectory}\<javadocDirectory/\>}}/\>
parameter can be used to include Javadoc
+ resources like HTML or images. By default, all javadoc resources are in
<$\{basedir\}/src/main/javadoc> directory.
Here is a typical set of resources files used by the Maven Javadoc plugin:
@@ -78,7 +78,7 @@
+-----+
By default, the Javadoc Plugin includes the
<$\{basedir\}/src/main/javadoc/overview.html> if it exists. You could also
- specify a specific <overview> file with the \<overview/\> parameter, for
instance:
+ specify a specific <overview> file with the
{{{../javadoc-mojo.html#overview}\<overview/\>}} parameter, for instance:
+-----+
<project>
@@ -131,7 +131,8 @@
For more information, see
{{{http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#packagecomment}
javadoc - The Java API Documentation Generator, Package Comment Files}}.
- Here is an example of a <package-info.java> file, located in
<$\{basedir\}/src/main/java/org/apache/myapp/package-info.java>:
+ Here is an example of a <package-info.java> file, located in
+ <$\{basedir\}/src/main/java/org/apache/myapp/package-info.java>:
+-----+
/**
@@ -146,15 +147,16 @@
These include images, sample source code, class files, applets, HTML files...
For more information, see
{{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/javadoc.html#unprocessed}
- javadoc - The Java API Documentation Generator, Miscellaneous Unprocessed
Files}} and
{{{http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#images}
- How to Write Doc Comments for the Javadoc Tool, Including Images }}.
+ javadoc - The Java API Documentation Generator, Miscellaneous Unprocessed
Files}} and
+ {{{http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#images}How
to Write Doc Comments for the Javadoc Tool, Including Images }}.
In addition to <doc-files> directories, since 2.6.1, the specific
<src/main/javadoc/resources> directory will be
copied to the generated Javadoc resources directory (i.e.
<apidocs/resources>). This is usefull when you want to
overwite default Javadoc tool resources, like the default <inherit.gif> to
one with a transparent background
(See {{{../images/inherit.gif}GIF}} or {{{../images/inherit.psd}PSD}}).
- Here is a sample javadoc comment to use <app.png> image, located in
<$\{basedir\}/src/main/javadoc/org/apache/myapp/doc-files> directory:
+ Here is a sample javadoc comment to use <app.png> image, located in
+ <$\{basedir\}/src/main/javadoc/org/apache/myapp/doc-files> directory:
+-----+
package org.apache.myapp;
@@ -169,4 +171,4 @@
+-----+
<<IMPORTANT NOTE>>: To allow the copy of unprocessed files, you need to run
the Javadoc Plugin with the
- <<<{{{../javadoc-mojo.html#docfilessubdirs}\<docfilessubdirs/\>}}>>>
parameter.
+ {{{../javadoc-mojo.html#docfilessubdirs}\<docfilessubdirs/\>}} parameter.
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/links-configuration.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/links-configuration.apt.vm?rev=813811&r1=813810&r2=813811&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/links-configuration.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/links-configuration.apt.vm
Fri Sep 11 12:44:39 2009
@@ -28,12 +28,13 @@
Configuring <<<links>>> Parameter
- You could add cross reference links to external projects. For instance:
+ You could add cross reference links to external projects using the
{{{../javadoc-mojo.html#links}\<links/\>}}
+ parameters. For instance:
+-----+
<project>
...
- <build>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -48,17 +49,19 @@
</configuration>
</plugin>
</plugins>
- </build>
+ </reporting> (or </build>)
...
</project>
+-----+
- <<Important Note>>: according the
{{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#package-list}Javadoc
specifications}},
+ <<Important Note>>: according the
+
{{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#package-list}Javadoc
specifications}},
all given links <<should>> have a fetchable <<</package-list>>> file.
Since 2.6, you could try to detect all Javadoc links for the project's
dependencies. You need to use the
- {{{../javadoc-mojo.html#detectLinks}detectLinks}} parameter. All detected
links are based on the default Maven
- conventions. For instance, if your project has a dependency to
{{{http://commons.apache.org/lang/}Apache Commons Lang}} i.e.:
+ {{{../javadoc-mojo.html#detectLinks}\<detectLinks/\>}} parameter. All
detected links are based on the default Maven
+ conventions. For instance, if your project has a dependency to
+ {{{http://commons.apache.org/lang/}Apache Commons Lang}} i.e.:
+-----+
<project>
@@ -76,34 +79,36 @@
The added Javadoc link will be {{http://commons.apache.org/lang/apidocs}}.
- Since 2.6, a {{{http://java.sun.com/reference/api/index.html}Javadoc API}}
link, depending the JDK version used by your
- project, will be added. The version of the Javadoc API is detected from the
value of the
-
<<<{{{http://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#source}source}}>>>
+ Since 2.6, a {{{http://java.sun.com/reference/api/index.html}Javadoc API}}
link, depending the JDK version used by
+ your project, will be added. The version of the Javadoc API is detected from
the value of the
+
{{{http://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#source}\<source/\>}}
parameter in the
<<<{{{http://maven.apache.org/plugins/maven-compiler-plugin}org.apache.maven.plugins:maven-compiler-plugin}}>>>
(defined in $\{project.build.plugins\} or in
$\{project.build.pluginManagement\}), or computed via the Javadoc Tool
executable. If you want to skip this link, you need to configure
- {{{../javadoc-mojo.html#detectJavaApiLink}detectJavaApiLink}} to <<<false>>>.
+ {{{../javadoc-mojo.html#detectJavaApiLink}\<detectJavaApiLink/\>}} to
<<<false>>>.
<<Note>>: if you are using an unsupported JDK like 7.0, you could add its
Javadoc API url using the
- {{{../javadoc-mojo.html#javaApiLinks}javaApiLinks}} parameter, i.e.:
+ {{{../javadoc-mojo.html#javaApiLinks}\<javaApiLinks/\>}} parameter, i.e.:
+-----+
- <javaApiLinks>
- ...
- <property>
- <name>api_1.7</name>
- <value>http://download.java.net/jdk7/docs/api/</value>
- </property>
- </javaApiLinks>
+<configuration>
+ <javaApiLinks>
+ <property>
+ <name>api_1.7</name>
+ <value>http://download.java.net/jdk7/docs/api/</value>
+ </property>
+ </javaApiLinks>
+ ...
+</configuration>
+-----+
~~ Using anchor links produces a Velocity error.
- Refer to {{{../javadoc-mojo.html}links}} parameter for more information.
+ Refer to {{{../javadoc-mojo.html}\<links/>}} parameter for more information.
Configuring <<<offlineLinks>>> Parameter
- If your project has modules, you could add cross reference links to your
modules when your goals are not aggregator goals.
- For instance, if your project has two modules i.e.:
+ If your project has modules, you could add cross reference links to your
modules when your goals are not aggregator
+ goals. For instance, if your project has two modules i.e.:
+-----+
<project>
@@ -122,6 +127,6 @@
<<Important Note>>: all offlinelinks are based on the $\{project.url\} if
present.
Since 2.6, you could disable the cross reference for <<<offlineLinks>>>
using the
- {{{../javadoc-mojo.html#detectOfflineLinks}detectOfflineLinks}} parameter.
+ {{{../javadoc-mojo.html#detectOfflineLinks}\<detectOfflineLinks/>}}
parameter.
- Refer to {{{../javadoc-mojo.html#offlineLinks}offlineLinks}} parameter for
more information.
+ Refer to {{{../javadoc-mojo.html#offlineLinks}\<offlineLinks/\>}} parameter
for more information.
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/selective-javadocs-report.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/selective-javadocs-report.apt.vm?rev=813811&r1=813810&r2=813811&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/selective-javadocs-report.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/selective-javadocs-report.apt.vm
Fri Sep 11 12:44:39 2009
@@ -29,7 +29,7 @@
Selective Javadocs Reports
To run the Javadocs reports selectively, you need to include only the
Javadocs reports that you prefer.
- Use "mvn site" to generate the selected reports.
+ Use <<<mvn site>>> to generate the selected reports.
+-----+
@@ -42,6 +42,7 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>${project.version}</version>
<configuration>
+ <!-- Default configuration for all reports -->
...
</configuration>
<reportSets>
@@ -49,6 +50,10 @@
<reports>
<report>javadoc</report>
<!-- <report>test-javadoc</report> -->
+ <configuration>
+ <!-- Specific configuration for the given report -->
+ ...
+ </configuration>
</reports>
</reportSet>
</reportSets>
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt.vm?rev=813811&r1=813810&r2=813811&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/stylesheet-configuration.apt.vm
Fri Sep 11 12:44:39 2009
@@ -29,7 +29,8 @@
Configuring Stylesheets
- If no custom stylesheet is specified in the \<stylesheetfile/\> parameter,
the \<stylesheet/\> parameter will indicate
+ If no custom stylesheet is specified in the
{{{../javadoc-mojo.html#stylesheetfile}\<stylesheetfile/\>}} parameter,
+ the {{{../javadoc-mojo.html#stylesheet}\<stylesheet/\>}} parameter will
indicate
which stylesheet will be used -- the stylesheet included in the maven javadoc
plugin or the default stylesheet used by
the javadoc tool. <<maven>> value indicates the maven javadoc plugin
stylesheet, while <<java>> value indicates the
default javadoc tool stylesheet. The default is <<java>> value if not
specified.
@@ -37,7 +38,7 @@
+-----+
<project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -50,21 +51,23 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
+-----+
Configuring Stylesheets File
- If a custom \<stylesheetfile/\> parameter is specified, you will be able to
use it:
+ If a custom {{{../javadoc-mojo.html#stylesheetfile}\<stylesheetfile/\>}}
parameter is specified, you will be able to
+ use it:
- * if \<stylesheetfile/\> is a given file, you could use an absolute or a
relative path, for instance:
+ * if {{{../javadoc-mojo.html#stylesheetfile}\<stylesheetfile/\>}} is a given
file, you could use an absolute or a
+ relative path, for instance:
+-----+
<project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -77,34 +80,18 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
+-----+
- * since 2.6, \<stylesheetfile/\> could be a resource in your project
directory, i.e. <<<src/main/java>>>,
- <<<src/main/resources>>> or <<<src/main/javadoc>>>, for instance:
+ * since 2.6, {{{../javadoc-mojo.html#stylesheetfile}\<stylesheetfile/\>}}
could be a resource in your project
+ directory, i.e. <<<src/main/java>>>, <<<src/main/resources>>> or
<<<src/main/javadoc>>>, for instance:
+-----+
<project>
...
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <stylesheetfile>path/to/your/stylesheet.css</stylesheetfile>
- ...
- </configuration>
- </plugin>
- </plugins>
- ...
- </build>
- ...
- <!-- Or the following
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -117,13 +104,13 @@
</plugin>
</plugins>
...
- </reporting>
- -->
+ </reporting> (or </build>)
...
</project>
+-----+
- * since 2.6, \<stylesheetfile/\> could be a resource in the Javadoc plugin
dependencies, for instance:
+ * since 2.6, {{{../javadoc-mojo.html#stylesheetfile}\<stylesheetfile/\>}}
could be a resource in the Javadoc plugin
+ dependencies, for instance:
+-----+
<project>
@@ -150,4 +137,4 @@
</build>
...
</project>
-+-----+
\ No newline at end of file
++-----+
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt.vm?rev=813811&r1=813810&r2=813811&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/tag-configuration.apt.vm
Fri Sep 11 12:44:39 2009
@@ -29,12 +29,12 @@
Configuring Custom Javadoc Tags
- You can configure any custom tags used in your javadoc via the \<tags/\>
element:
+ You can configure any custom tags used in your javadoc via the
{{{../javadoc-mojo.html#tags}\<tags/\>}} element:
+-----+
<project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -55,7 +55,7 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
+-----+
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/taglet-configuration.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/taglet-configuration.apt.vm?rev=813811&r1=813810&r2=813811&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/taglet-configuration.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/taglet-configuration.apt.vm
Fri Sep 11 12:44:39 2009
@@ -29,19 +29,19 @@
Configuring Custom Taglets
You could configure any custom taglets in your Javadoc Plugin configuration
via the \<taglet/\>, \<taglets/\>
- or \<tagletArtifacts/\> elements, depending the number of taglets used.
+ or \<tagletArtifacts/\> parameters, depending the number of taglets used.
For more information about the taglet technology, please refer to
{{http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/taglet/overview.html}}.
* One Taglet
- For one known Taglet, just use the \<taglet/\> element:
+ For one known Taglet, just use the
{{{../javadoc-mojo.html#taglet}\<taglet/\>}} parameter:
+-----+
<project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -61,19 +61,19 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
+-----+
* Several Taglets
- For several known Taglets, just use the \<taglets/\> element:
+ For several known Taglets, just use the
{{{../javadoc-mojo.html#taglets}\<taglets/\>}} parameter:
+-----+
<project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -108,18 +108,18 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
+-----+
- If it is several Taglets in the same Taglet artifact, you could use the
\<taglets/\> and the \<tagletArtifact/\>
- elements:
+ If it is several Taglets in the same Taglet artifact, you could use the
{{{../javadoc-mojo.html#taglets}\<taglets/\>}}
+ and the {{{../javadoc-mojo.html#tagletArtifact}\<tagletArtifact/\>}}
parameters:
+-----+
<project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -148,18 +148,18 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
+-----+
If you don't know the Taglets or if you want to auto-detect Taglet class
names, you could use the
- \<tagletArtifacts/\> element:
+ {{{../javadoc-mojo.html#tagletArtifacts}\<tagletArtifacts/\>}} parameter:
+-----+
<project>
...
- <reporting>
+ <reporting> (or <build>)
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -186,8 +186,7 @@
</plugin>
</plugins>
...
- </reporting>
+ </reporting> (or </build>)
...
</project>
+-----+
-
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/test-javadocs.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/test-javadocs.apt.vm?rev=813811&r1=813810&r2=813811&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/test-javadocs.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/test-javadocs.apt.vm
Fri Sep 11 12:44:39 2009
@@ -80,7 +80,7 @@
<project>
...
- <reporting>
+ <build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -96,7 +96,7 @@
</configuration>
</plugin>
</plugins>
- </reporting>
+ </build>
...
</project>
+-----+
