stephenc
/
maven-plugin-tools
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[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
master
Herve Boutemy 2014-12-14 18:23:20 +00:00
parent 5c7faf1b8e
commit 1f029f5fb1
4 changed files with 10 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
maven-plugin-plugin/src/it/plugin-info-jdk-default-version/invoker.properties
View File

@ -15,4 +15,4 @@
# specific language governing permissions and limitations # specific language governing permissions and limitations
# under the License. # under the License.
invoker.goals = clean site -DskipTests invoker.goals = clean plugin:report

57
maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/XdocGeneratorMojo.java
View File

@ -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 );
}
}

6
maven-plugin-plugin/src/site/apt/index.apt
View File

@ -39,10 +39,8 @@ Maven Plugin Plugin
* {{{./descriptor-mojo.html}plugin:descriptor}} generates a plugin descriptor, * {{{./descriptor-mojo.html}plugin:descriptor}} generates a plugin descriptor,
* {{{./report-mojo.html}plugin:report}} generates the plugin documentation report, listing each goal provided * {{{./report-mojo.html}plugin:report}} generates the plugin documentation: one overview report
and general configuration information (see {{{./plugin-info.html}example}}), (see {{{./plugin-info.html}example}}) and documentation for each plugin's goal (mojo),
* {{{./xdoc-mojo.html}plugin:xdoc}} generates documentation (as xdoc files) for each mojo (goals),
* {{{./updateRegistry-mojo.html}plugin:updateRegistry}} updates the user plugin registry (if it's in use) to * {{{./updateRegistry-mojo.html}plugin:updateRegistry}} updates the user plugin registry (if it's in use) to
reflect the version being installed, reflect the version being installed,

11
maven-plugin-plugin/src/site/apt/usage.apt
View File

@ -54,15 +54,18 @@ mvn package
mvn plugin:descriptor 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 * The <<<plugin:updateRegistry>>> Goal