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

improved documentation 

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1215323 13f79535-47bb-0310-9956-ffa450edef68
master
Herve Boutemy 2011-12-16 22:36:01 +00:00
parent 14fa7efb74
commit fb2232b54f
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
maven-plugin-tools-java/src/site/apt/index.apt
View File

@ -46,14 +46,14 @@ import org.apache.maven.plugin.AbstractMojo;
* @execute phase="<phaseName>" lifecycle="<lifecycleId>" goal="<goalName>" * @execute phase="<phaseName>" lifecycle="<lifecycleId>" goal="<goalName>"
* @executionStrategy <once-per-session|always> * @executionStrategy <once-per-session|always>
* @inheritByDefault <true|false> * @inheritByDefault <true|false>
* @instantiationStrategy <per-lookup> * @instantiationStrategy <per-lookup|singleton|keep-alive|poolable>
* @phase <phaseName> * @phase <phaseName>
* @requiresDependencyResolution <compile|runtime|compile+runtime|test> * @requiresDependencyResolution <compile|runtime|compile+runtime|test>
* @requiresDependencyCollection <compile|runtime|compile+runtime|test> (since Maven 3.0) * @requiresDependencyCollection <compile|runtime|compile+runtime|test> (since Maven 3.0)
* @requiresDirectInvocation <true|false> * @requiresDirectInvocation <false|true>
* @requiresOnline <true|false> * @requiresOnline <false|true>
* @requiresProject <true|false> * @requiresProject <true|false>
* @requiresReports <true|false> (unsupported since Maven 3.0) * @requiresReports <false|true> (unsupported since Maven 3.0)
* @threadSafe (since Maven 3.0) * @threadSafe (since Maven 3.0)
* @since <since-text> * @since <since-text>
* @deprecated <deprecated-text> * @deprecated <deprecated-text>
@ -63,7 +63,6 @@ public class MyMojo
{ {
/** /**
* @parameter alias="myAlias" implementation="" expression="${aSystemProperty}" default-value="${anExpression}" * @parameter alias="myAlias" implementation="" expression="${aSystemProperty}" default-value="${anExpression}"
* @component role="..." roleHint="..."
* @readonly * @readonly
* @required * @required
* @since <since-text> * @since <since-text>
@ -71,6 +70,15 @@ public class MyMojo
*/ */
private String parameter; private String parameter;
/**
* @component role="..." roleHint="..."
* @readonly
* @required
* @since <since-text>
* @deprecated <deprecated-text>
*/
private Component component;
public void execute() public void execute()
{ {
... ...
@ -80,6 +88,6 @@ public class MyMojo
* See also * See also
* {{{/developers/mojo-api-specification.html}Mojo API Specification}} * {{{/developers/mojo-api-specification.html#The_Descriptor_and_Annotations}Mojo API Specification}}
* {{{/ref/current/maven-plugin-api/plugin.html}META-INF/maven/plugin.xml plugin descriptor}} * {{{/ref/current/maven-plugin-api/plugin.html}META-INF/maven/plugin.xml plugin descriptor}}