(maven-dependency-plugin) branch master updated: Clean up parameters docs (#439)

[elharo]

This is an automated email from the ASF dual-hosted git repository.

elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-dependency-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new 5e492770 Clean up parameters docs (#439)
5e492770 is described below

commit 5e4927707de3499d97d48272e0c60bcfc8fcf0ff
Author: Elliotte Rusty Harold <elh...@users.noreply.github.com>
AuthorDate: Sat Oct 19 15:56:23 2024 +0000

    Clean up parameters docs (#439)
    
    * Clean up parameters docs
---
 .../dependency/analyze/AbstractAnalyzeMojo.java    | 30 +++-------------------
 1 file changed, 4 insertions(+), 26 deletions(-)

diff --git 
a/src/main/java/org/apache/maven/plugins/dependency/analyze/AbstractAnalyzeMojo.java
 
b/src/main/java/org/apache/maven/plugins/dependency/analyze/AbstractAnalyzeMojo.java
index ebff3dce..ba3fb677 100644
--- 
a/src/main/java/org/apache/maven/plugins/dependency/analyze/AbstractAnalyzeMojo.java
+++ 
b/src/main/java/org/apache/maven/plugins/dependency/analyze/AbstractAnalyzeMojo.java
@@ -74,8 +74,6 @@ public abstract class AbstractAnalyzeMojo extends 
AbstractMojo {
      * <a 
href="/shared/maven-dependency-analyzer/">maven-dependency-analyzer</a> is 
used. To use this, you must declare
      * a dependency for this plugin that contains the code for the analyzer. 
The analyzer must have a declared Plexus
      * role name, and you specify the role name here.
-     *
-     * @since 2.2
      */
     @Parameter(property = "analyzer", defaultValue = "default")
     private String analyzer;
@@ -114,47 +112,37 @@ public abstract class AbstractAnalyzeMojo extends 
AbstractMojo {
      * the <i>Non-test scoped test only dependencies found</i> warning to the
      * <code>&lt;ignoredNonTestScopedDependencies&gt;</code> configuration.
      *
-     * @since 3.3.1-SNAPSHOT
+     * @since 3.3.1
      */
     @Parameter(property = "ignoreAllNonTestScoped", defaultValue = "false")
     private boolean ignoreAllNonTestScoped;
 
     /**
-     * Output the xml for the missing dependencies (used but not declared).
-     *
-     * @since 2.0-alpha-5
+     * Output XML for the missing dependencies (used but not declared).
      */
     @Parameter(property = "outputXML", defaultValue = "false")
     private boolean outputXML;
 
     /**
      * Output scriptable values for the missing dependencies (used but not 
declared).
-     *
-     * @since 2.0-alpha-5
      */
     @Parameter(property = "scriptableOutput", defaultValue = "false")
     private boolean scriptableOutput;
 
     /**
      * Flag to use for scriptable output.
-     *
-     * @since 2.0-alpha-5
      */
     @Parameter(property = "scriptableFlag", defaultValue = "$$$%%%")
     private String scriptableFlag;
 
     /**
-     * Flag to use for scriptable output
-     *
-     * @since 2.0-alpha-5
+     * Base directory for output.
      */
     @Parameter(defaultValue = "${basedir}", readonly = true)
     private File baseDir;
 
     /**
-     * Target folder
-     *
-     * @since 2.0-alpha-5
+     * Target directory.
      */
     @Parameter(defaultValue = "${project.build.directory}", readonly = true)
     private File outputDirectory;
@@ -162,16 +150,12 @@ public abstract class AbstractAnalyzeMojo extends 
AbstractMojo {
     /**
      * Force dependencies as used, to override incomplete result caused by 
bytecode-level analysis. Dependency format is
      * <code>groupId:artifactId</code>.
-     *
-     * @since 2.6
      */
     @Parameter
     private String[] usedDependencies;
 
     /**
      * Skip plugin execution completely.
-     *
-     * @since 2.7
      */
     @Parameter(property = "mdep.analyze.skip", defaultValue = "false")
     private boolean skip;
@@ -190,8 +174,6 @@ public abstract class AbstractAnalyzeMojo extends 
AbstractMojo {
      * For example, <code>org.apache.*</code> will match all artifacts whose 
group id starts with
      * <code>org.apache.</code>, and <code>:::*-SNAPSHOT</code> will match all 
snapshot artifacts.
      * </p>
-     *
-     * @since 2.10
      */
     @Parameter
     private String[] ignoredDependencies = new String[0];
@@ -209,8 +191,6 @@ public abstract class AbstractAnalyzeMojo extends 
AbstractMojo {
      * For example, <code>org.apache.*</code> will match all artifacts whose 
group id starts with
      * <code>org.apache.</code>, and <code>:::*-SNAPSHOT</code> will match all 
snapshot artifacts.
      * </p>
-     *
-     * @since 2.10
      */
     @Parameter
     private String[] ignoredUsedUndeclaredDependencies = new String[0];
@@ -228,8 +208,6 @@ public abstract class AbstractAnalyzeMojo extends 
AbstractMojo {
      * For example, <code>org.apache.*</code> matches all artifacts whose 
group id starts with
      * <code>org.apache.</code>, and <code>:::*-SNAPSHOT</code> will match all 
snapshot artifacts.
      * </p>
-     *
-     * @since 2.10
      */
     @Parameter(defaultValue = "org.slf4j:slf4j-simple::")
     private String[] ignoredUnusedDeclaredDependencies;