From 1f029f5fb1f2d3e7e5316ea939541552d454d9f1 Mon Sep 17 00:00:00 2001
From: Herve Boutemy <hboutemy@apache.org>
Date: Sun, 14 Dec 2014 18:23:20 +0000
Subject: [PATCH] [MPLUGIN-280] removed obsolete xdoc goal since it was
 superceeded by report goal/report

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1645484 13f79535-47bb-0310-9956-ffa450edef68
---
 .../invoker.properties                        |  2 +-
 .../plugin/plugin/XdocGeneratorMojo.java      | 57 -------------------
 maven-plugin-plugin/src/site/apt/index.apt    |  6 +-
 maven-plugin-plugin/src/site/apt/usage.apt    | 11 ++--
 4 files changed, 10 insertions(+), 66 deletions(-)
 delete mode 100644 maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/XdocGeneratorMojo.java

diff --git a/maven-plugin-plugin/src/it/plugin-info-jdk-default-version/invoker.properties b/maven-plugin-plugin/src/it/plugin-info-jdk-default-version/invoker.properties
index abdde0d..a16bae8 100644
--- a/maven-plugin-plugin/src/it/plugin-info-jdk-default-version/invoker.properties
+++ b/maven-plugin-plugin/src/it/plugin-info-jdk-default-version/invoker.properties
@@ -15,4 +15,4 @@
 # specific language governing permissions and limitations
 # under the License.
 
-invoker.goals = clean site -DskipTests
+invoker.goals = clean plugin:report
diff --git a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/XdocGeneratorMojo.java b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/XdocGeneratorMojo.java
deleted file mode 100644
index be5ba76..0000000
--- a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/XdocGeneratorMojo.java
+++ /dev/null
@@ -1,57 +0,0 @@
-package org.apache.maven.plugin.plugin;
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you 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.
- */
-
-import org.apache.maven.plugins.annotations.Mojo;
-import org.apache.maven.plugins.annotations.Parameter;
-import org.apache.maven.tools.plugin.generator.Generator;
-import org.apache.maven.tools.plugin.generator.PluginXdocGenerator;
-
-import java.io.File;
-
-/**
- * Generate Xdoc files for the project mojos or goals.
- *
- * @author <a href="mailto:brett@apache.org">Brett Porter</a>
- * @version $Id$
- * @since 2.0
- */
-@Mojo( name = "xdoc", threadSafe = true )
-public class XdocGeneratorMojo
-    extends AbstractGeneratorMojo
-{
-    /**
-     * The directory where the generated Xdoc files will be put.
-     */
-    @Parameter( defaultValue = "${project.build.directory}/generated-site/xdoc" )
-    protected File outputDirectory;
-
-    /** {@inheritDoc} */
-    protected File getOutputDirectory()
-    {
-        return outputDirectory;
-    }
-
-    /** {@inheritDoc} */
-    protected Generator createGenerator()
-    {
-        return new PluginXdocGenerator( project );
-    }
-}
diff --git a/maven-plugin-plugin/src/site/apt/index.apt b/maven-plugin-plugin/src/site/apt/index.apt
index e9d9c4b..61f554c 100644
--- a/maven-plugin-plugin/src/site/apt/index.apt
+++ b/maven-plugin-plugin/src/site/apt/index.apt
@@ -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,
diff --git a/maven-plugin-plugin/src/site/apt/usage.apt b/maven-plugin-plugin/src/site/apt/usage.apt
index 5a38b9c..10d0d98 100644
--- a/maven-plugin-plugin/src/site/apt/usage.apt
+++ b/maven-plugin-plugin/src/site/apt/usage.apt
@@ -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