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

improved documentation: replaced links to annotations javadoc with link to annotations intro page 

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1470118 13f79535-47bb-0310-9956-ffa450edef68
master
Herve Boutemy 2013-04-20 07:18:23 +00:00
parent ef3b5a16ba
commit 10acc051bf
1 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
maven-plugin-plugin/src/site/apt/examples/using-annotations.apt.vm
View File

@ -48,9 +48,7 @@ Using Plugin Tools Java5 Annotations
<groupId>org.apache.maven.plugin-tools</groupId> <groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId> <artifactId>maven-plugin-annotations</artifactId>
<version>${project.version}</version> <version>${project.version}</version>
<!-- annotations are not needed for plugin execution so you can remove this dependency <scope>provided</scope><!-- annotations are needed only to build the plugin -->
for execution with using provided scope -->
<scope>provided</scope>
</dependency> </dependency>
</dependencies> </dependencies>
... ...
@ -93,32 +91,30 @@ Using Plugin Tools Java5 Annotations
* 2 class-level annotations: * 2 class-level annotations:
* <<<@Mojo>>>: This annotation will mark your class as a Mojo. See * <<<@Mojo>>>: This annotation will mark your class as a Mojo,
{{{/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Mojo.html}javadoc}} for more information.
* <<<@Execute>>>: Used if your Mojo need to fork a lifecycle. See * <<<@Execute>>>: Used if your Mojo needs to fork a lifecycle,
{{{/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Execute.html}javadoc}} for more information.
[] []
* 2 field-level annotations: * 2 field-level annotations:
* <<<@Parameter>>>: Used to configure your Mojo parameters. See * <<<@Parameter>>>: Used to configure your Mojo parameters,
{{{/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html}javadoc}} for more information.
* <<<@Component>>>: Used to configure injection of Plexus components or Maven context components. See * <<<@Component>>>: Used to configure injection of Plexus components or Maven context components.
{{{/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Component.html}javadoc}} for more information.
[] []
[] []
Plugin Tools Java 5 Annotations ({{{../../maven-plugin-tools-annotations/index.html}see full example}}) For more information on these annotations, see the
are named after Plugin Tools Javadoc Tags ({{{../../maven-plugin-tools-java/index.html}see full example}}), {{{../../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: with following little differences:
*-------------------------------+---------------+ *-------------------------------+---------------+
|| Plugin Tools Javadoc Tags || Plugin Tools Java 5 Annotation || || {{{../../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" )>>> | <<<@goal "goal-name">>> | <<<@Mojo( name = "goal-name" )>>>
*-------------------------------+---------------+ *-------------------------------+---------------+