svn commit: r1341647 - /maven/plugin-tools/trunk/maven-plugin-tools-annotations/src/site/apt/index.apt

[hb...@apache.org]

Author: hboutemy
Date: Tue May 22 21:35:43 2012
New Revision: 1341647

URL: http://svn.apache.org/viewvc?rev=1341647&view=rev
Log:
o fixed role as Class<?> type
o improved examples

Modified:
    maven/plugin-tools/trunk/maven-plugin-tools-annotations/src/site/apt/index.apt

Modified: maven/plugin-tools/trunk/maven-plugin-tools-annotations/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-annotations/src/site/apt/index.apt?rev=1341647&r1=1341646&r2=1341647&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-annotations/src/site/apt/index.apt (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-annotations/src/site/apt/index.apt Tue May 22 21:35:43 2012
@@ -45,17 +45,17 @@ import org.apache.maven.plugins.annotati
 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>
  * @deprecated <deprecated-text>
  */
-@Mojo( name = "<goalName>",
+@Mojo( name = "<goal-name>",
        aggregator = <false|true>, 
-       configurator = "<roleHint>",
+       configurator = "<role hint>",
        executionStrategy = "<once-per-session|always>",
        inheritByDefault = <true|false>,
        instantiationStrategy = InstanciationStrategy.<strategy>,
-       defaultPhase = "<phaseName>",
+       defaultPhase = "<phase-name>",
        requiresDependencyResolution = ResolutionScope.<scope>,
        requiresDependencyCollection = ResolutionScope.<scope>, // (since Maven 3.0)
        requiresDirectInvocation = <false|true>,
@@ -63,9 +63,9 @@ import org.apache.maven.plugins.annotati
        requiresProject = <true|false>,
        requiresReports = <false|true>, // (unsupported since Maven 3.0)
        threadSafe = <false|true> ) // (since Maven 3.0)
-@Execute( goal = "<goalName>",
+@Execute( goal = "<goal-name>",
           phase = LifecyclePhase.<phase>
-          lifecycle = "<lifecycleId>" )
+          lifecycle = "<lifecycle-id>" )
 public class MyMojo
     extends AbstractMojo
 {
@@ -74,8 +74,8 @@ public class MyMojo
      * @deprecated <deprecated-text>
      */
     @Parameter( alias = "myAlias",
-                property = "aProperty",
-                defaultValue = "${anExpression}",
+                property = "a.property",
+                defaultValue = "an expression with ${variables} eventually",
                 readonly = <false|true>
                 required = <false|true> )
     private String parameter;
@@ -84,8 +84,8 @@ public class MyMojo
      * @since <since-text>
      * @deprecated <deprecated-text>
      */
-    @Component( role = "...",
-                roleHint="..." )
+    @Component( role = MyComponentExtension.class,
+                roleHint = "..." )
     private MyComponent component;
 
     public void execute()