Squashed commit of the following:

commit 049228ce76927a6740500e1b750f0e8f201f2478
Author: rfscholte <rfscholte@apache.org>
Date:   Mon Mar 27 20:22:46 2017 +0200

    [MNG-6185] Replace doclettag explanation with annotations in AbstractMojo javadoc

    Fix by Checkstyle reported issues

commit 63796a649e6e3b25a58fb567d354ca1849f48819
Author: rfscholte <rfscholte@apache.org>
Date:   Sat Mar 25 23:15:00 2017 +0100

    [MNG-6185] Replace doclettag explanation with annotations in AbstractMojo javadoc
This commit is contained in:
rfscholte 2017-03-29 19:50:15 +02:00
parent 0baa423452
commit 00c82b7e23
1 changed files with 17 additions and 20 deletions

View File

@ -27,17 +27,15 @@ import org.apache.maven.plugin.logging.SystemStreamLog;
/** /**
* Abstract class to provide most of the infrastructure required to implement a <code>Mojo</code> except for * Abstract class to provide most of the infrastructure required to implement a <code>Mojo</code> except for
* the execute method.<br> * the execute method.<br>
* The implementation should have a <code>goal</code> annotation in the class-level javadoc annotation: * The implementation should have a <code>Mojo</code> annotation with the name of the goal:
* <pre> * <pre>
* &#47;&#42;&#42; * &#64;Mojo( name = "&lt;goal-name&gt;" )
* &#42; &#64;goal goalName
* &#42;&#47;
* </pre> * </pre>
* <p> * <p>
* There are also a number of class-level javadoc annotations which can be used to control how and when the * There are also a number of attributes which can be used to control how and when the
* <code>Mojo</code> is executed: * <code>Mojo</code> is executed:
* </p> * </p>
* <table border="1" summary="class-level doclettags"> * <table border="1" summary="mojo annotation attributes">
* <tr bgcolor="#CCCCCC"> * <tr bgcolor="#CCCCCC">
* <th>Descriptor Element</th> * <th>Descriptor Element</th>
* <th>Annotation</th> * <th>Annotation</th>
@ -46,7 +44,7 @@ import org.apache.maven.plugin.logging.SystemStreamLog;
* </tr> * </tr>
* <tr> * <tr>
* <td>goal</td> * <td>goal</td>
* <td>@goal &lt;goalName&gt;</td> * <td>name = "&lt;goal-name&gt;"</td>
* <td>Yes</td> * <td>Yes</td>
* <td>The name for the Mojo that users will reference from the command line to execute the Mojo directly, * <td>The name for the Mojo that users will reference from the command line to execute the Mojo directly,
* or inside a POM in order to provide Mojo-specific configuration.</td> * or inside a POM in order to provide Mojo-specific configuration.</td>
@ -65,7 +63,7 @@ import org.apache.maven.plugin.logging.SystemStreamLog;
* </tr> * </tr>
* <tr> * <tr>
* <td>configurator</td> * <td>configurator</td>
* <td>@configurator &lt;roleHint&gt;</td> * <td>configurator = "&lt;role-hint&gt;"</td>
* <td>No</td> * <td>No</td>
* <td>The configurator type to use when injecting parameter values into this Mojo. The value is normally * <td>The configurator type to use when injecting parameter values into this Mojo. The value is normally
* deduced from the Mojo's implementation language, but can be specified to allow a custom * deduced from the Mojo's implementation language, but can be specified to allow a custom
@ -77,7 +75,7 @@ import org.apache.maven.plugin.logging.SystemStreamLog;
* </tr> * </tr>
* <tr> * <tr>
* <td>phase</td> * <td>phase</td>
* <td>@phase &lt;phaseName&gt;</td> * <td>defaultPhase = LifecyclePhase.&lt;phase&gt;</td>
* <td>No</td> * <td>No</td>
* <td>Binds this Mojo to a particular phase of the standard build lifecycle, if specified. * <td>Binds this Mojo to a particular phase of the standard build lifecycle, if specified.
* <br> * <br>
@ -86,7 +84,8 @@ import org.apache.maven.plugin.logging.SystemStreamLog;
* </tr> * </tr>
* <tr> * <tr>
* <td>execute</td> * <td>execute</td>
* <td>@execute [phase=&lt;phaseName&gt;|goal=&lt;goalName&gt;] [lifecycle=&lt;lifecycleId&gt;]</td> * <td>@Execute
* ( phase=LifecyclePhase.&lt;phase&gt;, goal= "&lt;goal-name&gt;", lifecycle="&lt;lifecycle-id&gt;" )</td>
* <td>No</td> * <td>No</td>
* <td>When this goal is invoked, it will first invoke a parallel lifecycle, ending at the given phase. * <td>When this goal is invoked, it will first invoke a parallel lifecycle, ending at the given phase.
* If a goal is provided instead of a phase, that goal will be executed in isolation. * If a goal is provided instead of a phase, that goal will be executed in isolation.
@ -99,7 +98,7 @@ import org.apache.maven.plugin.logging.SystemStreamLog;
* </tr> * </tr>
* <tr> * <tr>
* <td>requiresDependencyResolution</td> * <td>requiresDependencyResolution</td>
* <td>@requiresDependencyResolution &lt;requiredScope&gt;</td> * <td>requiresDependencyResolution = ResolutionScope.&lt;scope&gt;</td>
* <td>No</td> * <td>No</td>
* <td>Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be * <td>Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be
* resolved before it can execute. * resolved before it can execute.
@ -128,6 +127,9 @@ import org.apache.maven.plugin.logging.SystemStreamLog;
* </td> * </td>
* </tr> * </tr>
* </table> * </table>
* <p>This is only a small set of all the options. A complete list can be found at
* <a href="https://maven.apache.org/components/plugin-tools/maven-plugin-tools-annotations/index.html" target="_blank">
* Maven Plugin Tool for Annotations</a>.
* *
* @see <a href="https://maven.apache.org/guides/plugin/guide-java-plugin-development.html" target="_blank">Guide to Developing Java Plugins</a> * @see <a href="https://maven.apache.org/guides/plugin/guide-java-plugin-development.html" target="_blank">Guide to Developing Java Plugins</a>
* @see <a href="https://maven.apache.org/guides/mini/guide-configuring-plugins.html" target="_blank">Guide to Configuring Plug-ins</a> * @see <a href="https://maven.apache.org/guides/mini/guide-configuring-plugins.html" target="_blank">Guide to Configuring Plug-ins</a>
@ -146,9 +148,7 @@ public abstract class AbstractMojo
/** Plugin container context */ /** Plugin container context */
private Map pluginContext; private Map pluginContext;
/** @Override
* @see org.apache.maven.plugin.Mojo#setLog(org.apache.maven.plugin.logging.Log)
*/
public void setLog( Log log ) public void setLog( Log log )
{ {
this.log = log; this.log = log;
@ -167,6 +167,7 @@ public abstract class AbstractMojo
* *
* @see org.apache.maven.plugin.Mojo#getLog() * @see org.apache.maven.plugin.Mojo#getLog()
*/ */
@Override
public Log getLog() public Log getLog()
{ {
if ( log == null ) if ( log == null )
@ -177,17 +178,13 @@ public abstract class AbstractMojo
return log; return log;
} }
/** @Override
* @see org.apache.maven.plugin.ContextEnabled#getPluginContext()
*/
public Map getPluginContext() public Map getPluginContext()
{ {
return pluginContext; return pluginContext;
} }
/** @Override
* @see org.apache.maven.plugin.ContextEnabled#setPluginContext(java.util.Map)
*/
public void setPluginContext( Map pluginContext ) public void setPluginContext( Map pluginContext )
{ {
this.pluginContext = pluginContext; this.pluginContext = pluginContext;