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 be555a809..f609a83b7 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 true 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 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 8ad6b9f42..8787a08b6 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 List execute( PluginToolsRequest request ) /** * @param scriptFilesKeyedByBasedir not null * @param outputDirectory not null + * @param request the request * @throws ExtractionException if any */ protected void copyScriptsToOutputDirectory( Map> scriptFilesKeyedByBasedir, @@ -132,6 +133,7 @@ protected void copyScriptsToOutputDirectory( Map> scriptFilesK * @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> gatherFilesByBasedir( File basedir, List directories, @@ -198,7 +200,7 @@ protected List extractMojoDescriptorsFromMetadata( Map extractMojoDescriptors( Map> sc } /** + * @param request the request * @return the file extension like .bsh 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 f510b97a3..3a4f36cc1 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 @@ void populatePluginDescriptor( PluginToolsRequest request ) throws ExtractionException, InvalidPluginDescriptorException; /** + *

* Sets the active extractors. - *

+ *

+ *

* Only the specified extractors will be used, all others will be skipped. - * + *

* @param extractors The names of the active extractors. If this parameter is null, * all the scanner's extractors are considered active. Set entries that are null or * empty ("") will be ignored.