cleaning some javadoc

Signed-off-by: olivier lamy <[email protected]>
apache · Oct 25, 2018 · 6b3122c · 6b3122c
1 parent 8bd74fc
commit 6b3122c
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 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
@@ -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/...java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java b/...java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java
@@ -80,6 +80,7 @@ public List<MojoDescriptor> execute( PluginToolsRequest request )
     /**
      * @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 @@ protected void copyScriptsToOutputDirectory( Map<String, Set<File>> 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<String, Set<File>> gatherFilesByBasedir( File basedir, List<String> directories,
@@ -198,7 +200,7 @@ protected List<MojoDescriptor> extractMojoDescriptorsFromMetadata( Map<String, S
 
     /**
      * Should be implemented in the sub classes.
-     *
+     * @param request the request
      * @return always null
      */
     protected String getMetadataFileExtension( PluginToolsRequest request )
@@ -223,6 +225,7 @@ protected List<MojoDescriptor> extractMojoDescriptors( Map<String, Set<File>> sc
     }
 
     /**
+     * @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
@@ -44,10 +44,12 @@ void populatePluginDescriptor( PluginToolsRequest request )
         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.