From 0a4d198a47f78ca7847fa86d13494bc217c7245a Mon Sep 17 00:00:00 2001 From: Herve Boutemy Date: Sat, 20 Apr 2013 07:23:30 +0000 Subject: [PATCH] switched Annotations and POM Configuration paragraphs to match with user's interest: start with annotations, end with pre-requisites git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1470120 13f79535-47bb-0310-9956-ffa450edef68 --- .../apt/examples/using-annotations.apt.vm | 78 ++++++++++--------- 1 file changed, 40 insertions(+), 38 deletions(-) diff --git a/maven-plugin-plugin/src/site/apt/examples/using-annotations.apt.vm b/maven-plugin-plugin/src/site/apt/examples/using-annotations.apt.vm index d03c397..07f8b95 100644 --- a/maven-plugin-plugin/src/site/apt/examples/using-annotations.apt.vm +++ b/maven-plugin-plugin/src/site/apt/examples/using-annotations.apt.vm @@ -28,14 +28,52 @@ Using Plugin Tools Java5 Annotations - Since version 3.0, you can use {{{#Annotations}Java5 annotations}} to generate the plugin descriptor file. + Since version 3.0, you can use Java5 annotations to generate the plugin descriptor file. <> With annotations, it's not any more mandatory to have your Mojos super classes in the same project. Super classes can now come from reactor projects or external dependencies. As javadoc doclet are still useful for <<<@since>>>, <<<@deprecated>>> and comments, the sources are still scanned. So if you use an external dependency, you must still provide an artifact with sources (<<>> classifier) to provide documentation (the tooling will skip error if this artifact sources is missing). -* Pom configuration +* Annotations + + Information for plugin descriptor generation is specified using 4 annotations: + + * 2 class-level annotations: + + * <<<@Mojo>>>: This annotation will mark your class as a Mojo, + + * <<<@Execute>>>: Used if your Mojo needs to fork a lifecycle, + + [] + + * 2 field-level annotations: + + * <<<@Parameter>>>: Used to configure your Mojo parameters, + + * <<<@Component>>>: Used to configure injection of Plexus components or Maven context components. + + [] + + [] + + For more information on these annotations, see the + {{{../../maven-plugin-tools-annotations/index.html#Supported_Annotations}corresponding documentation}}. + + Notice that Plugin Tools Java 5 Annotations are named after Plugin Tools Javadoc Tags + with following little differences: + +*-------------------------------+---------------+ +|| {{{../../maven-plugin-tools-java/index.html}Plugin Tools Javadoc Tags}} || {{{../../maven-plugin-tools-annotations/index.html}Plugin Tools Java 5 Annotation}} || +*-------------------------------+---------------+ +| <<<@goal "goal-name">>> | <<<@Mojo( name = "goal-name" )>>> +*-------------------------------+---------------+ +| <<<@phase "\">>> | <<<@Mojo( defaultPhase = LifecyclePhase.\ )>>> +*-------------------------------+---------------+ + +* POM configuration + + To be able to use these Java 5 annotations, you need to add some configuration to your plugin POM: +-----+ @@ -84,39 +122,3 @@ Using Plugin Tools Java5 Annotations ... +-----+ - -* Annotations - - Information for plugin descriptor generation is specified using 4 annotations: - - * 2 class-level annotations: - - * <<<@Mojo>>>: This annotation will mark your class as a Mojo, - - * <<<@Execute>>>: Used if your Mojo needs to fork a lifecycle, - - [] - - * 2 field-level annotations: - - * <<<@Parameter>>>: Used to configure your Mojo parameters, - - * <<<@Component>>>: Used to configure injection of Plexus components or Maven context components. - - [] - - [] - - For more information on these annotations, see the - {{{../../maven-plugin-tools-annotations/index.html#Supported_Annotations}corresponding documentation}}. - - Notice that Plugin Tools Java 5 Annotations are named after Plugin Tools Javadoc Tags - with following little differences: - -*-------------------------------+---------------+ -|| {{{../../maven-plugin-tools-java/index.html}Plugin Tools Javadoc Tags}} || {{{../../maven-plugin-tools-annotations/index.html}Plugin Tools Java 5 Annotation}} || -*-------------------------------+---------------+ -| <<<@goal "goal-name">>> | <<<@Mojo( name = "goal-name" )>>> -*-------------------------------+---------------+ -| <<<@phase "\">>> | <<<@Mojo( defaultPhase = LifecyclePhase.\ )>>> -*-------------------------------+---------------+