Author: jdcasey
Date: Mon Apr 12 21:26:13 2010
New Revision: 933421
URL: http://svn.apache.org/viewvc?rev=933421&view=rev
Log:
[MJAVADOC-280] Cleaning up documentation, and bumping version to 2.7-SNAPSHOT
since this is a fairly large new feature.
Modified:
maven/plugins/trunk/maven-javadoc-plugin/pom.xml
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestResourcesBundleMojo.java
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate-dependency-sources.apt.vm
Modified: maven/plugins/trunk/maven-javadoc-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/pom.xml?rev=933421&r1=933420&r2=933421&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/pom.xml Mon Apr 12 21:26:13 2010
@@ -30,7 +30,7 @@ under the License.
</parent>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>2.6.2-SNAPSHOT</version>
+ <version>2.7-SNAPSHOT</version>
<packaging>maven-plugin</packaging>
<name>Maven Javadoc Plugin</name>
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java?rev=933421&r1=933420&r2=933421&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
Mon Apr 12 21:26:13 2010
@@ -130,7 +130,7 @@ public abstract class AbstractJavadocMoj
* Classifier used in the name of the javadoc-options XML file, and in the
resources bundle
* artifact that gets attached to the project. This one is used for
non-test javadocs.
*
- * @since 2.6.2
+ * @since 2.7
* @see #TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER
*/
public static final String JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER =
"javadoc-resources";
@@ -139,7 +139,7 @@ public abstract class AbstractJavadocMoj
* Classifier used in the name of the javadoc-options XML file, and in the
resources bundle
* artifact that gets attached to the project. This one is used for
test-javadocs.
*
- * @since 2.6.2
+ * @since 2.7
* @see #JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER
*/
public static final String TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER =
"test-javadoc-resources";
@@ -1584,7 +1584,7 @@ public abstract class AbstractJavadocMoj
* This is useful when creating javadocs for a distribution project.
*
* @parameter default-value="false"
- * @since 2.6.2
+ * @since 2.7
*/
private boolean includeDependencySources;
@@ -1592,7 +1592,7 @@ public abstract class AbstractJavadocMoj
* Directory where unpacked project sources / test-sources should be
cached.
*
* @parameter
default-value="${project.build.directory}/distro-javadoc-sources"
- * @since 2.6.2
+ * @since 2.7
* @see #includeDependencySources
*/
private File sourceDependencyCacheDir;
@@ -1602,7 +1602,7 @@ public abstract class AbstractJavadocMoj
* in this javadoc run.
*
* @parameter default-value="false"
- * @since 2.6.2
+ * @since 2.7
* @see #includeDependencySources
*/
private boolean includeTransitiveDependencySources;
@@ -1612,7 +1612,7 @@ public abstract class AbstractJavadocMoj
*
*
* @parameter
- * @since 2.6.2
+ * @since 2.7
* @see #includeDependencySources
*/
private List<String> dependencySourceIncludes;
@@ -1622,7 +1622,7 @@ public abstract class AbstractJavadocMoj
*
*
* @parameter
- * @since 2.6.2
+ * @since 2.7
* @see #includeDependencySources
*/
private List<String> dependencySourceExcludes;
@@ -1633,7 +1633,7 @@ public abstract class AbstractJavadocMoj
*
* @parameter
default-value="${project.build.directory}/javadoc-bundle-options"
* @readonly
- * @since 2.6.2
+ * @since 2.7
*/
private File javadocOptionsDir;
@@ -1641,7 +1641,7 @@ public abstract class AbstractJavadocMoj
* Transient variable to allow lazy-resolution of javadoc bundles from
dependencies, so they can
* be used at various points in the javadoc generation process.
*
- * @since 2.6.2
+ * @since 2.7
*/
private transient List<JavadocBundle> dependencyJavadocBundles;
@@ -2184,7 +2184,7 @@ public abstract class AbstractJavadocMoj
* Construct a SourceResolverConfig for resolving dependency sources and
resources in a consistent
* way, so it can be reused for both source and resource resolution.
*
- * @since 2.6.2
+ * @since 2.7
*/
private SourceResolverConfig getDependencySourceResolverConfig()
{
@@ -5718,7 +5718,7 @@ public abstract class AbstractJavadocMoj
* Construct the output file for the generated javadoc-options XML file,
after creating the
* javadocOptionsDir if necessary. This method does NOT write to the file
in question.
*
- * @since 2.6.2
+ * @since 2.7
*/
protected final File getJavadocOptionsFile()
{
@@ -5735,7 +5735,7 @@ public abstract class AbstractJavadocMoj
* supplying to a distro module in a includeDependencySources
configuration, so the javadoc options
* from this execution can be reconstructed and merged in the distro build.
*
- * @since 2.6.2
+ * @since 2.7
*/
protected final JavadocOptions buildJavadocOptions()
throws IOException
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java?rev=933421&r1=933420&r2=933421&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/ResourcesBundleMojo.java
Mon Apr 12 21:26:13 2010
@@ -39,7 +39,7 @@ import java.io.IOException;
*
* @goal resource-bundle
* @phase package
- * @since 2.6.2
+ * @since 2.7
*/
public class ResourcesBundleMojo
extends AbstractJavadocMojo
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestResourcesBundleMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestResourcesBundleMojo.java?rev=933421&r1=933420&r2=933421&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestResourcesBundleMojo.java
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/TestResourcesBundleMojo.java
Mon Apr 12 21:26:13 2010
@@ -30,7 +30,7 @@ import java.io.File;
*
* @goal test-resource-bundle
* @phase package
- * @since 2.6.2
+ * @since 2.7
*/
public class TestResourcesBundleMojo
extends ResourcesBundleMojo
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate-dependency-sources.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate-dependency-sources.apt.vm?rev=933421&r1=933420&r2=933421&view=diff
==============================================================================
---
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate-dependency-sources.apt.vm
(original)
+++
maven/plugins/trunk/maven-javadoc-plugin/src/site/apt/examples/aggregate-dependency-sources.apt.vm
Mon Apr 12 21:26:13 2010
@@ -28,7 +28,7 @@
Aggregating Javadocs from Dependency Sources
- <<Since: 2.6.2>>
+ <<Since: 2.7>>
Consider the following project dependency graph:
@@ -58,7 +58,7 @@ org.test:project-distro:0.1
containing not only what little code is in the distro project itself - which
isn't likely to be very enlightening -
but also the javadocs for your other projects, which are dependencies of the
distribution.
- Since version <2.6.2> of the maven-javadoc-plugin, you can do this using the
<<<includeDependencySources>>> flag and
+ Since version <2.7> of the maven-javadoc-plugin, you can do this using the
<<<includeDependencySources>>> flag and
its associated configuration options. Using this flag, it's possible to
aggregate sources from other modules in a
multi-module build <or> use the <<<sources>>> and <<<test-sources>>> jars
published alongside the main artifacts for
your projects. It's also possible to fine-tune which dependencies' sources
should be aggregated, and which ignored.
@@ -85,7 +85,6 @@ org.test:project-distro:0.1
[...]
<groupId>org.test.dep</groupId>
<artifactId>project-A</artifactId>
- <version>1.0</version>
[...]
<build>
<plugins>
@@ -113,8 +112,8 @@ org.test:project-distro:0.1
</project>
+-----+
- <<NOTE: If you don't intend to generate test javadocs that include
dependency sources, you can omit the
- <<<test-jar>>> goal above.>>
+ <<NOTE:>> If you don't intend to generate test javadocs that include
dependency sources, you can omit the
+ <<<test-jar>>> goal above.
At this point, your project is ready to produce the artifacts necessary to
support dependency-driven javadoc aggregation.
The next time you install or deploy the project, the appropriate artifacts
will be available for your distribution
@@ -151,7 +150,7 @@ org.test:project-distro:0.1
[...]
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>@pom.version@</version>
+ <version>${project.version}</version>
<executions>
<execution>
<id>javadoc-jar</id>
@@ -199,7 +198,7 @@ org.test:project-distro:0.1
If you have customized configuration for generating the javadocs in these
dependency projects,
you may wish to propagate these customizations to the distribution project
itself. To do this, use the <<<resource-bundle>>>
- and <<<test-resource-bundle>>> goals, new in version <<2.6.2>> of the
javadoc plugin. These will create new artifacts
+ and <<<test-resource-bundle>>> goals, new in version <<2.7>> of the javadoc
plugin. These will create new artifacts
that contain the javadoc configuration options plus the contents of
$\{javadocDirectory} (which defaults to src/main/javadoc),
or $\{tetsJavadocDirectory} (which defaults to src/test/javadoc) depending
on the bundle goal. If these artifacts are
available, the dependency-driven aggregation process will include the
content and configuration they contain when
@@ -217,7 +216,7 @@ org.test:project-distro:0.1
[...]
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>@pom.version@</version>
+ <version>${project.version}</version>
<executions>
<execution>
<id>resource-bundles</id>
@@ -242,5 +241,6 @@ org.test:project-distro:0.1
</project>
+-----+
- <<NOTE: Again, if you don't need to generate test javadocs, you can omit the
<<<test-resource-bundle>>> goal above.>>
- <<NOTE 2: The configuration option <<<detectOfflineLinks>>> is provided as
an example only. It is not required.>>>
+ <<NOTE:>> Again, if you don't need to generate test javadocs, you can omit
the <<<test-resource-bundle>>> goal above.
+
+ <<NOTE 2:>> The configuration option <<<detectOfflineLinks>>> is provided as
an example only. It is not required.
