You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2014/12/14 19:23:21 UTC

svn commit: r1645484 - in /maven/plugin-tools/trunk/maven-plugin-plugin/src: it/plugin-info-jdk-default-version/invoker.properties main/java/org/apache/maven/plugin/plugin/XdocGeneratorMojo.java site/apt/index.apt site/apt/usage.apt

Author: hboutemy
Date: Sun Dec 14 18:23:20 2014
New Revision: 1645484

URL: http://svn.apache.org/r1645484
Log:
[MPLUGIN-280] removed obsolete xdoc goal since it was superceeded by report goal/report

Removed:
    maven/plugin-tools/trunk/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/XdocGeneratorMojo.java
Modified:
    maven/plugin-tools/trunk/maven-plugin-plugin/src/it/plugin-info-jdk-default-version/invoker.properties
    maven/plugin-tools/trunk/maven-plugin-plugin/src/site/apt/index.apt
    maven/plugin-tools/trunk/maven-plugin-plugin/src/site/apt/usage.apt

Modified: maven/plugin-tools/trunk/maven-plugin-plugin/src/it/plugin-info-jdk-default-version/invoker.properties
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-plugin/src/it/plugin-info-jdk-default-version/invoker.properties?rev=1645484&r1=1645483&r2=1645484&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-plugin/src/it/plugin-info-jdk-default-version/invoker.properties (original)
+++ maven/plugin-tools/trunk/maven-plugin-plugin/src/it/plugin-info-jdk-default-version/invoker.properties Sun Dec 14 18:23:20 2014
@@ -15,4 +15,4 @@
 # specific language governing permissions and limitations
 # under the License.
 
-invoker.goals = clean site -DskipTests
+invoker.goals = clean plugin:report

Modified: maven/plugin-tools/trunk/maven-plugin-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-plugin/src/site/apt/index.apt?rev=1645484&r1=1645483&r2=1645484&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-plugin/src/site/apt/index.apt (original)
+++ maven/plugin-tools/trunk/maven-plugin-plugin/src/site/apt/index.apt Sun Dec 14 18:23:20 2014
@@ -39,10 +39,8 @@ Maven Plugin Plugin
 
    * {{{./descriptor-mojo.html}plugin:descriptor}} generates a plugin descriptor,
 
-   * {{{./report-mojo.html}plugin:report}} generates the plugin documentation report, listing each goal provided
-   and general configuration information (see {{{./plugin-info.html}example}}),
-
-   * {{{./xdoc-mojo.html}plugin:xdoc}} generates documentation (as xdoc files) for each mojo (goals),
+   * {{{./report-mojo.html}plugin:report}} generates the plugin documentation: one overview report
+     (see {{{./plugin-info.html}example}}) and documentation for each plugin's goal (mojo),
 
    * {{{./updateRegistry-mojo.html}plugin:updateRegistry}} updates the user plugin registry (if it's in use) to
       reflect the version being installed,

Modified: maven/plugin-tools/trunk/maven-plugin-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-plugin/src/site/apt/usage.apt?rev=1645484&r1=1645483&r2=1645484&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-plugin/src/site/apt/usage.apt (original)
+++ maven/plugin-tools/trunk/maven-plugin-plugin/src/site/apt/usage.apt Sun Dec 14 18:23:20 2014
@@ -54,15 +54,18 @@ mvn package
 mvn plugin:descriptor
 +-----+
 
-* The <<<plugin:xdoc>>> Goal
+* The <<<plugin:report>>> Goal
 
-  To generate Xdoc files for the mojos of your plugin, execute the following on the command line:
+  To generate the documentation of your plugin, execute the following on the command line:
 
 +-----+
-mvn plugin:xdoc
+mvn plugin:report
 +-----+
 
-  The xdoc file is generated by default in <<<$\{project.build.directory\}/generated-site/xdoc>>>.
+  The xdoc files, one per goal, are generated by default in <<<$\{project.build.directory\}/generated-site/xdoc>>>,
+  and an overview is generated in the site output.
+
+  If you add the plugin to the <<<reporting>>> section of your pom, you'll get the full report as html with <<<mvn site>>>.
 
 * The <<<plugin:updateRegistry>>> Goal