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

o fixed role as Class<?> type 

o improved examples

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1341647 13f79535-47bb-0310-9956-ffa450edef68
master
Herve Boutemy 2012-05-22 21:35:43 +00:00
parent e5f2c4746d
commit b3be96af8e
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -45,17 +45,17 @@ import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter; import org.apache.maven.plugins.annotations.Parameter;
/** /**
* Mojo Description. @Mojo( name = "<goalName>" ) is the minimal required annotation. * Mojo Description. @Mojo( name = "<goal-name>" ) is the minimal required annotation.
* @since <since-text> * @since <since-text>
* @deprecated <deprecated-text> * @deprecated <deprecated-text>
*/ */
@Mojo( name = "<goalName>", @Mojo( name = "<goal-name>",
aggregator = <false|true>, aggregator = <false|true>,
configurator = "<roleHint>", configurator = "<role hint>",
executionStrategy = "<once-per-session|always>", executionStrategy = "<once-per-session|always>",
inheritByDefault = <true|false>, inheritByDefault = <true|false>,
instantiationStrategy = InstanciationStrategy.<strategy>, instantiationStrategy = InstanciationStrategy.<strategy>,
defaultPhase = "<phaseName>", defaultPhase = "<phase-name>",
requiresDependencyResolution = ResolutionScope.<scope>, requiresDependencyResolution = ResolutionScope.<scope>,
requiresDependencyCollection = ResolutionScope.<scope>, // (since Maven 3.0) requiresDependencyCollection = ResolutionScope.<scope>, // (since Maven 3.0)
requiresDirectInvocation = <false|true>, requiresDirectInvocation = <false|true>,
@ -63,9 +63,9 @@ import org.apache.maven.plugins.annotations.Parameter;
requiresProject = <true|false>, requiresProject = <true|false>,
requiresReports = <false|true>, // (unsupported since Maven 3.0) requiresReports = <false|true>, // (unsupported since Maven 3.0)
threadSafe = <false|true> ) // (since Maven 3.0) threadSafe = <false|true> ) // (since Maven 3.0)
@Execute( goal = "<goalName>", @Execute( goal = "<goal-name>",
phase = LifecyclePhase.<phase> phase = LifecyclePhase.<phase>
lifecycle = "<lifecycleId>" ) lifecycle = "<lifecycle-id>" )
public class MyMojo public class MyMojo
extends AbstractMojo extends AbstractMojo
{ {
@ -74,8 +74,8 @@ public class MyMojo
* @deprecated <deprecated-text> * @deprecated <deprecated-text>
*/ */
@Parameter( alias = "myAlias", @Parameter( alias = "myAlias",
property = "aProperty", property = "a.property",
defaultValue = "${anExpression}", defaultValue = "an expression with ${variables} eventually",
readonly = <false|true> readonly = <false|true>
required = <false|true> ) required = <false|true> )
private String parameter; private String parameter;
@ -84,8 +84,8 @@ public class MyMojo
* @since <since-text> * @since <since-text>
* @deprecated <deprecated-text> * @deprecated <deprecated-text>
*/ */
@Component( role = "...", @Component( role = MyComponentExtension.class,
roleHint="..." ) roleHint = "..." )
private MyComponent component; private MyComponent component;
public void execute() public void execute()