You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ol...@apache.org on 2018/10/25 07:26:29 UTC
[maven-plugin-tools] branch master updated (8bd74fc -> 26ba032)
This is an automated email from the ASF dual-hosted git repository.
olamy pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/maven-plugin-tools.git.
from 8bd74fc add some testing for annotation inheritance but not sure we need it...
new 6b3122c cleaning some javadoc
new 26ba032 fixing some javadoc, remaining are due to Modello so skip javadoc failure
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../maven/plugin/plugin/AbstractGeneratorMojo.java | 7 +-
.../plugin/plugin/DescriptorGeneratorMojo.java | 6 +-
.../apache/maven/plugin/plugin/PluginReport.java | 5 +-
.../maven/tools/plugin/PluginToolsRequest.java | 17 +-
.../AbstractScriptedMojoDescriptorExtractor.java | 5 +-
.../maven/tools/plugin/scanner/MojoScanner.java | 6 +-
.../JavaJavadocMojoDescriptorExtractor.java | 3 +-
.../extractor/javadoc/JavadocMojoAnnotation.java | 269 ++++++++++++++++-----
pom.xml | 9 +-
9 files changed, 244 insertions(+), 83 deletions(-)
[maven-plugin-tools] 02/02: fixing some javadoc,
remaining are due to Modello so skip javadoc failure
Posted by ol...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
olamy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-plugin-tools.git
commit 26ba0323bfd66214222b1be4d71402b0948d51bf
Author: olivier lamy <ol...@apache.org>
AuthorDate: Thu Oct 25 17:26:10 2018 +1000
fixing some javadoc, remaining are due to Modello so skip javadoc failure
Signed-off-by: olivier lamy <ol...@apache.org>
---
.../maven/plugin/plugin/AbstractGeneratorMojo.java | 7 +-
.../plugin/plugin/DescriptorGeneratorMojo.java | 6 +-
.../apache/maven/plugin/plugin/PluginReport.java | 5 +-
.../JavaJavadocMojoDescriptorExtractor.java | 3 +-
.../extractor/javadoc/JavadocMojoAnnotation.java | 269 ++++++++++++++++-----
pom.xml | 9 +-
6 files changed, 225 insertions(+), 74 deletions(-)
diff --git a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.java b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.java
index 7fa1c55..849ea2e 100644
--- a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.java
+++ b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.java
@@ -92,13 +92,14 @@ public abstract class AbstractGeneratorMojo
protected boolean skipErrorNoDescriptorsFound;
/**
+ * <p>
* The role names of mojo extractors to use.
- * <p/>
+ * </p>
+ * <p>
* If not set, all mojo extractors will be used. If set to an empty extractor name, no mojo extractors
* will be used.
- * <p/>
+ * </p>
* Example:
- * <p/>
* <pre>
* <!-- Use all mojo extractors -->
* <extractors/>
diff --git a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/DescriptorGeneratorMojo.java b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/DescriptorGeneratorMojo.java
index 69bf990..a0bcf5c 100644
--- a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/DescriptorGeneratorMojo.java
+++ b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/DescriptorGeneratorMojo.java
@@ -29,14 +29,16 @@ import org.apache.maven.tools.plugin.generator.Generator;
import org.apache.maven.tools.plugin.generator.PluginDescriptorGenerator;
/**
+ * <p>
* Generate a plugin descriptor.
- * <br/>
+ * </p>
+ * <p>
* <b>Note:</b> Since 3.0, for Java plugin annotations support,
* default <a href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">phase</a>
* defined by this goal is after the "compilation" of any scripts. This doesn't override
* <a href="/ref/current/maven-core/default-bindings.html#Bindings_for_maven-plugin_packaging">the default binding coded
* at generate-resources phase</a> in Maven core.
- *
+ * </p>
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @since 2.0
*/
diff --git a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java
index f005ce4..886951f 100644
--- a/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java
+++ b/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java
@@ -136,12 +136,15 @@ public class PluginReport
private Requirements requirements;
/**
+ * <p>
* The goal prefix that will appear before the ":".
* By default, this plugin applies a heuristic to derive a heuristic from
* the plugin's artifactId.
- * <p/>
+ * </p>
+ * <p>
* It removes any occurrences of the regular expression <strong>-?maven-?</strong>,
* and then removes any occurrences of <strong>-?plugin-?</strong>.
+ * </p>
* <p>
* For example, horsefeature-maven-plugin becomes horsefeature.
* </p>
diff --git a/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/javadoc/JavaJavadocMojoDescriptorExtractor.java b/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/javadoc/JavaJavadocMojoDescriptorExtractor.java
index 72b84d1..5b5e493 100644
--- a/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/javadoc/JavaJavadocMojoDescriptorExtractor.java
+++ b/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/javadoc/JavaJavadocMojoDescriptorExtractor.java
@@ -53,8 +53,9 @@ import com.thoughtworks.qdox.model.JavaField;
import com.thoughtworks.qdox.model.JavaType;
/**
+ * <p>
* Extracts Mojo descriptors from <a href="http://java.sun.com/">Java</a> sources.
- * <br/>
+ * </p>
* For more information about the usage tag, have a look to:
* <a href="http://maven.apache.org/developers/mojo-api-specification.html">
* http://maven.apache.org/developers/mojo-api-specification.html</a>
diff --git a/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/javadoc/JavadocMojoAnnotation.java b/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/javadoc/JavadocMojoAnnotation.java
index 79dcc70..3b9877c 100644
--- a/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/javadoc/JavadocMojoAnnotation.java
+++ b/maven-plugin-tools-java/src/main/java/org/apache/maven/tools/plugin/extractor/javadoc/JavadocMojoAnnotation.java
@@ -33,205 +33,291 @@ public interface JavadocMojoAnnotation
// ----------------------------------------------------------------------
/**
+ * <p>
* Flags this Mojo to run it in a multi module way, i.e. aggregate the build with the set of projects listed
* as modules.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@aggregator</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String AGGREGATOR = "aggregator";
/**
+ * <p>
* 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 ComponentConfigurator
* implementation to be used.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@configurator <roleHint></code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String CONFIGURATOR = "configurator";
/**
+ * <p>
* The description for the Mojo.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@description</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Mojo's description is auto-detected.
+ * </p>
*/
String DESCRIPTION = "description";
/**
+ * <p>
* Refer to <code>@execute ...</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String EXECUTE = "execute";
/**
+ * <p>
* The Mojo goal will be executed in isolation.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@execute goal="<goalName>"</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String EXECUTE_GOAL = "goal";
/**
+ * <p>
* The Mojo will be invoked in a parallel lifecycle.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@execute lifecycle="<lifecycleId>"</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String EXECUTE_LIFECYCLE = "lifecycle";
/**
+ * <p>
* The Mojo will be invoked in a parallel lifecycle, ending at the given phase.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@execute phase="<phaseName>"</code>.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@execute lifecycle="<lifecycleId>" phase="<phaseName>"</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String EXECUTE_PHASE = "phase";
/**
+ * <p>
* Refer to <code>@executionStrategy <strategy></code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String EXECUTION_STATEGY = "executionStrategy";
/**
+ * <p>
* The name for the Mojo that users will reference to execute it.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@goal <goalName></code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String GOAL = "goal";
/**
+ * <p>
* The Mojo's fully-qualified class name.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@implementation</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Mojo's implementation is auto-detected.
+ * </p>
*/
String IMPLEMENTATION = "implementation";
/**
+ * <p>
* Allow Mojo inheritance.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@inheritByDefault <true|false></code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String INHERIT_BY_DEFAULT = "inheritByDefault";
/**
+ * <p>
* Refer to <code>@instantiationStrategy <per-lookup></code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String INSTANTIATION_STRATEGY = "instantiationStrategy";
/**
+ * <p>
* The implementation language for the Mojo.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@language</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Mojo's implementation is auto-detected.
+ * </p>
*/
String LANGUAGE = "language";
/**
+ * <p>
* Specifies the execution strategy.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@attainAlways</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
- * @deprecated use <code>@executionStrategy always</code> instead
+ * </p>
+ * @deprecated use <code>@executionStrategy always</code> instead
*/
String MULTI_EXECUTION_STRATEGY = "attainAlways";
/**
+ * <p>
* Refer to <code>@phase <phaseName></code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String PHASE = "phase";
/**
+ * <p>
* Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be resolved
* before it can execute. Currently supports <code>compile</code>, <code>runtime</code>,
* <code>compile+runtime</code> and <code>test</code> scopes.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@requiresDependencyResolution <requiredScope></code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String REQUIRES_DEPENDENCY_RESOLUTION = "requiresDependencyResolution";
/**
+ * <p>
* Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be collected
* before it can execute. Currently supports <code>compile</code>, <code>runtime</code>,
* <code>compile+runtime</code> and <code>test</code> scopes.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@requiresDependencyCollection <requiredScope></code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String REQUIRES_DEPENDENCY_COLLECTION = "requiresDependencyCollection";
/**
+ * <p>
* Refer to <code>@requiresDirectInvocation <true|false></code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String REQUIRES_DIRECT_INVOCATION = "requiresDirectInvocation";
/**
+ * <p>
* Flags this Mojo to run online.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@requiresOnline <true|false></code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String REQUIRES_ONLINE = "requiresOnline";
/**
+ * <p>
* Flags this Mojo to run inside of a project.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@requiresProject <true|false></code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String REQUIRES_PROJECT = "requiresProject";
/**
+ * <p>
* Flags this Mojo to run inside reports.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@requiresReports <true|false></code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String REQUIRES_REPORTS = "requiresReports";
/**
+ * <p>
* Indicates that this mojo is thread-safe and can be run in parallel.
- *
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Type.
+ * </p>
*/
String THREAD_SAFE = "threadSafe";
@@ -241,110 +327,155 @@ public interface JavadocMojoAnnotation
// ----------------------------------------------------------------------
/**
+ * <p>
* Populate the field with an instance of a Plexus component. This is like declaring a requirement in a
* Plexus component.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@component ...</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Field.
+ * </p>
*/
String COMPONENT = "component";
/**
+ * <p>
* Refer to <code>@component role="..."</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Field.
+ * </p>
*/
String COMPONENT_ROLE = "role";
/**
+ * <p>
* Refer to <code>@component roleHint="..."</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Field.
+ * </p>
*/
String COMPONENT_ROLEHINT = "roleHint";
/**
+ * <p>
* Refer to <code>@parameter ...</code>
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Field.
+ * </p>
*/
String PARAMETER = "parameter";
/**
+ * <p>
* This defines the name of the bean property used to get/set the field: by default, field name is used.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@parameter name="..."</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Field.
+ * </p>
*/
String PARAMETER_NAME = "name";
/**
+ * <p>
* This defines an alias which can be used to configure a parameter. This is primarily useful to improve
* user-friendliness.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@parameter alias="..."</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Field.
+ * </p>
*/
String PARAMETER_ALIAS = "alias";
/**
+ * <p>
* This defines the default value to be injected into this parameter of the Mojo at build time.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@parameter default-value="..."</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Field.
+ * </p>
*/
String PARAMETER_DEFAULT_VALUE = "default-value";
/**
+ * <p>
* This defines the expression used to calculate the value to be injected into this parameter of the
* Mojo at build time.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@parameter expression="..."</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Field.
+ * </p>
* @deprecated use PARAMETER_PROPERTY instead
*/
String PARAMETER_EXPRESSION = "expression";
/**
+ * <p>
* This defines the property used to calculate the value to be injected into this parameter of the
* Mojo at build time, which can come from <code>-D</code> execution, setting properties or pom properties.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@parameter property="..."</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Field.
+ * </p>
*/
String PARAMETER_PROPERTY = "property";
/**
+ * <p>
* This defines the default implementation in the case the parameter type is an interface.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@parameter implementation="..."</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Field.
+ * </p>
*/
String PARAMETER_IMPLEMENTATION = "implementation";
/**
+ * <p>
* Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified
* configuration).
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@readonly</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Field.
+ * </p>
*/
String READONLY = "readonly";
/**
+ * <p>
* Specifies that this parameter is required for the Mojo to function.
- * <br/>
+ * </p>
+ * <p>
* Refer to <code>@required</code>.
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Should be defined in a Mojo Field.
+ * </p>
*/
String REQUIRED = "required";
@@ -353,16 +484,22 @@ public interface JavadocMojoAnnotation
// ----------------------------------------------------------------------
/**
+ * <p>
* Refer to <code>@since <deprecated-text></code>
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Could be defined in a Mojo Type or a Mojo Field.
+ * </p>
*/
String SINCE = "since";
/**
+ * <p>
* Refer to <code>@deprecated <since-text></code>
- * <br/>
+ * </p>
+ * <p>
* <b>Note</b>: Could be defined in a Mojo Type or a Mojo Field.
+ * </p>
*/
String DEPRECATED = "deprecated";
diff --git a/pom.xml b/pom.xml
index 7a557e4..334c306 100644
--- a/pom.xml
+++ b/pom.xml
@@ -63,7 +63,6 @@
<module>maven-plugin-tools-api</module>
<module>maven-plugin-tools-java</module>
<module>maven-plugin-tools-annotations</module>
- <!--module>maven-plugin-tools-javadoc</module-->
<module>maven-plugin-annotations</module>
<module>maven-script</module>
<module>maven-plugin-plugin</module><!-- keep at end since ITs require every extractors -->
@@ -258,6 +257,14 @@
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <!-- modello generate java sources with errors so do not fail -->
+ <failOnError>false</failOnError>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.7.1</version>
</plugin>
[maven-plugin-tools] 01/02: cleaning some javadoc
Posted by ol...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
olamy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-plugin-tools.git
commit 6b3122cead9d67b8cc9cdfcf7b7064040c959f3f
Author: olivier lamy <ol...@apache.org>
AuthorDate: Thu Oct 25 12:23:40 2018 +1000
cleaning some javadoc
Signed-off-by: olivier lamy <ol...@apache.org>
---
.../apache/maven/tools/plugin/PluginToolsRequest.java | 17 +++++++++++------
.../AbstractScriptedMojoDescriptorExtractor.java | 5 ++++-
.../apache/maven/tools/plugin/scanner/MojoScanner.java | 6 ++++--
3 files changed, 19 insertions(+), 9 deletions(-)
diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/PluginToolsRequest.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/PluginToolsRequest.java
index be555a8..f609a83 100644
--- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/PluginToolsRequest.java
+++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/PluginToolsRequest.java
@@ -39,23 +39,27 @@ public interface PluginToolsRequest
{
/**
- * Return the current {@link MavenProject} instance in use.
+ * @return Return the current {@link MavenProject} instance in use.
*/
MavenProject getProject();
/**
+ * @param project the current {@link MavenProject}
* @see PluginToolsRequest#getProject()
+ * @return This request.
*/
PluginToolsRequest setProject( MavenProject project );
/**
- * Return the {@link PluginDescriptor} currently being populated as part of the build of the
+ * @return Return the {@link PluginDescriptor} currently being populated as part of the build of the
* current plugin project.
*/
PluginDescriptor getPluginDescriptor();
/**
* @see PluginToolsRequest#getPluginDescriptor()
+ * @param pluginDescriptor the {@link PluginDescriptor}
+ * @return This request.
*/
PluginToolsRequest setPluginDescriptor( PluginDescriptor pluginDescriptor );
@@ -79,7 +83,8 @@ public interface PluginToolsRequest
* By default an exception is throw if no mojo descriptor is found. As the maven-plugin is defined in core, the
* descriptor generator mojo is bound to generate-resources phase.
* But for annotations, the compiled classes are needed, so skip error
- *
+ * @param skipErrorNoDescriptorsFound <code>true</code> to skip errors because of not found descriptors
+ * @return This request.
* @since 3.0
*/
PluginToolsRequest setSkipErrorNoDescriptorsFound( boolean skipErrorNoDescriptorsFound );
@@ -99,7 +104,7 @@ public interface PluginToolsRequest
Set<Artifact> getDependencies();
/**
- * @param dependencies
+ * @param dependencies the dependencies
* @return This request.
* @since 3.0
*/
@@ -114,7 +119,7 @@ public interface PluginToolsRequest
/**
*
- * @param remoteRepos
+ * @param remoteRepos the remote repositories
* @return This request.
* @since 3.0
*/
@@ -129,7 +134,7 @@ public interface PluginToolsRequest
/**
*
- * @param local
+ * @param local the local repository
* @return This request.
* @since 3.0
*/
diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java
index 8ad6b9f..8787a08 100644
--- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java
+++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java
@@ -80,6 +80,7 @@ public abstract class AbstractScriptedMojoDescriptorExtractor
/**
* @param scriptFilesKeyedByBasedir not null
* @param outputDirectory not null
+ * @param request the request
* @throws ExtractionException if any
*/
protected void copyScriptsToOutputDirectory( Map<String, Set<File>> scriptFilesKeyedByBasedir,
@@ -132,6 +133,7 @@ public abstract class AbstractScriptedMojoDescriptorExtractor
* @param basedir not null
* @param directories not null
* @param scriptFileExtension not null
+ * @param request the request
* @return map with subdirs paths as key
*/
protected Map<String, Set<File>> gatherFilesByBasedir( File basedir, List<String> directories,
@@ -198,7 +200,7 @@ public abstract class AbstractScriptedMojoDescriptorExtractor
/**
* Should be implemented in the sub classes.
- *
+ * @param request the request
* @return always null
*/
protected String getMetadataFileExtension( PluginToolsRequest request )
@@ -223,6 +225,7 @@ public abstract class AbstractScriptedMojoDescriptorExtractor
}
/**
+ * @param request the request
* @return the file extension like <code>.bsh</code> for BeanShell.
*/
protected abstract String getScriptFileExtension( PluginToolsRequest request );
diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/scanner/MojoScanner.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/scanner/MojoScanner.java
index f510b97..3a4f36c 100644
--- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/scanner/MojoScanner.java
+++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/scanner/MojoScanner.java
@@ -44,10 +44,12 @@ public interface MojoScanner
throws ExtractionException, InvalidPluginDescriptorException;
/**
+ * <p>
* Sets the active extractors.
- * <p/>
+ * </p>
+ * <p>
* Only the specified extractors will be used, all others will be skipped.
- *
+ * </p>
* @param extractors The names of the active extractors. If this parameter is <code>null</code>,
* all the scanner's extractors are considered active. Set entries that are <code>null</code> or
* empty ("") will be ignored.