Author: brett
Date: Sun Nov 26 14:42:01 2006
New Revision: 479436
URL: http://svn.apache.org/viewvc?view=rev&rev=479436
Log:
make the @component example clearer
Modified:
maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml
Modified: maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml?view=diff&rev=479436&r1=479435&r2=479436
==============================================================================
--- maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml
(original)
+++ maven/site/trunk/src/site/xdoc/developers/mojo-api-specification.xml Sun
Nov 26 14:42:01 2006
@@ -619,11 +619,13 @@
<td>configuration</td>
<td>@component</td>
<td>No</td>
- <td>Indicates to lookup and populate the field with an
implementation with a Plexus Component.
- Similar to <code>@parameter
expression="${component.yourpackage.YourComponentClass}"</code>.
+ <td>
+ Populates the field with an instance of a Plexus component. This
is like declaring a <i>requirement</i> in a Plexus component.
+ The default requirement will have a role equal to the declared
type of the field, and will use the default role hint. You can customise either
of these by providing a <code>role</code> and/or <code>roleHint</code>
parameter.
- <i>NOTE: 'YourComponentClass' should have a Plexus tag, for
instance
- <code>@plexus.component
role="yourpackage.YourComponentClass"</code>.</i>
+ <i>e.g.</i> <code>@component
role="org.apache.maven.artifact.ArtifactHandler" roleHint="ear"</code>
+
+ <b>Note:</b> This is identical to the deprecated form of
parameter: <code>@parameter
expression="${component.yourpackage.YourComponentClass}"</code>.
</td>
</tr>
<tr>
