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

added links to Plugin Descriptor reference documentation 

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1337970 13f79535-47bb-0310-9956-ffa450edef68
master
Herve Boutemy 2012-05-13 19:21:49 +00:00
parent 1176e0624c
commit 1e332e1122
5 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -28,7 +28,7 @@
Maven Plugin Plugin
The Maven Plugin Plugin is used to create a Maven plugin descriptor for any
The Maven Plugin Plugin is used to create a {{{/ref/current/maven-plugin-api/plugin.html}Maven plugin descriptor}} for any
{{{/general.html#What_is_a_Mojo}Mojo}}'s found in the source tree, to include in the JAR.
It is also used to generate report files for the Mojos as well as for updating the plugin registry, the artifact
metadata and generating a generic help goal.

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

@ -36,7 +36,8 @@ Usage
* The <<<plugin:descriptor>>> Goal
The <<<plugin:descriptor>>> goal is bound to the <<<process-classes>>> phase since 3.0; it was bound to <<<generate-resources>>> phase previously.
This goal generates the plugin descriptor, which is an xml file that contains information about the plugin.
This goal generates the plugin descriptor, which is an xml file that contains information about the plugin
(see {{{/ref/current/maven-plugin-api/plugin.html}descriptor's reference}}).
For example, you want to create an archive of your plugin and you execute

1
maven-plugin-plugin/src/site/site.xml
View File

@ -39,6 +39,7 @@ under the License.
<menu name="Developers">
<item name="Maven Plugin Tools" href="/plugin-tools/index.html"/>
<item name="Maven Plugin Descriptor" href="/ref/current/maven-plugin-api/plugin.html"/>
<item name="Multiple Language Support: Redesign Notes" href="multiple-language-support.html"/>
</menu>
</body>

2
maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginDescriptorGenerator.java
View File

@ -51,6 +51,8 @@ import java.util.Properties;
import java.util.Set;
/**
* Generate a <a href="/ref/current/maven-plugin-api/plugin.html">Maven Plugin Descriptor XML file</a>.
*
* @version $Id$
* @todo add example usage tag that can be shown in the doco
* @todo need to add validation directives so that systems embedding maven2 can

2
src/site/apt/index.apt
View File

@ -39,7 +39,7 @@ Maven Plugin Tools
*-----------------------------------------------------------------------------+---------------------------------------------------------+
| {{{./maven-plugin-tools-api/index.html}maven-plugin-tools-api}} | Descriptor extractor API, used by maven-plugin-plugin to extract Plugin information.
*-----------------------------------------------------------------------------+---------------------------------------------------------+
| {{{./maven-plugin-tools-generators/index.html}maven-plugin-tools-generators}} | Generators (help, documentation), used by maven-plugin-plugin to generate content from descriptor.
| {{{./maven-plugin-tools-generators/index.html}maven-plugin-tools-generators}} | Generators (descriptor, help, documentation), used by maven-plugin-plugin to generate content from descriptor.
*-----------------------------------------------------------------------------+---------------------------------------------------------+
| \ \ {{{./maven-plugin-tools-java/index.html}maven-plugin-tools-java}} | Descriptor extractor for plugins written in Java annotated with Mojo Javadoc Tags.
*-----------------------------------------------------------------------------+---------------------------------------------------------+