diff --git a/maven-plugin-tools-java/src/site/apt/index.apt b/maven-plugin-tools-java/src/site/apt/index.apt index 84bf789..9816cf5 100644 --- a/maven-plugin-tools-java/src/site/apt/index.apt +++ b/maven-plugin-tools-java/src/site/apt/index.apt @@ -2,8 +2,9 @@ Introduction ------ Vincent Siveton + Hervé Boutemy ------ - 2008-07-15 + 2011-10-23 ------ ~~ Licensed to the Apache Software Foundation (ASF) under one @@ -30,3 +31,55 @@ Maven Plugin Tool for Java The Maven Plugin Tool for Java is the Java impl of {{{../maven-plugin-tools-api/index.html}maven-plugin-tools-api}} to extract descriptors for plugins written in Java. + +* Supported javadoc annotations + ++---------+ +import org.apache.maven.plugin.AbstractMojo; + +/** + * Mojo Description: goal is the only required annotation. + * + * @goal + * @aggregator + * @configurator + * @execute phase="" lifecycle="" goal="" + * @executionStrategy + * @inheritByDefault + * @instantiationStrategy + * @phase + * @requiresDependencyResolution + * @requiresDependencyCollection (since Maven 3.0) + * @requiresDirectInvocation + * @requiresOnline + * @requiresProject + * @requiresReports (unsupported since Maven 3.0) + * @threadSafe (since Maven 3.0) + * @since + * @deprecated + */ +public class MyMojo + extends AbstractMojo +{ + /** + * @parameter alias="myAlias" implementation="" expression="${aSystemProperty}" default-value="${anExpression}" + * @component role="..." roleHint="..." + * @readonly + * @required + * @since + * @deprecated + */ + private String parameter; + + public void execute() + { + ... + } +} ++---------+ + +* See also + + * {{{/developers/mojo-api-specification.html}Mojo API Specification}} + + * {{{/ref/current/maven-plugin-api/plugin.html}META-INF/maven/plugin.xml plugin descriptor}}