You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by el...@apache.org on 2024/10/14 12:01:55 UTC
(maven-dependency-plugin) branch prop created (now 7e9aa28c)
This is an automated email from the ASF dual-hosted git repository.
elharo pushed a change to branch prop
in repository https://gitbox.apache.org/repos/asf/maven-dependency-plugin.git
at 7e9aa28c Clean up parameters docs
This branch includes the following new commits:
new 7e9aa28c Clean up parameters docs
The 1 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.
(maven-dependency-plugin) 01/01: Clean up parameters docs
Posted by el...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch prop
in repository https://gitbox.apache.org/repos/asf/maven-dependency-plugin.git
commit 7e9aa28c90841cc176c80e684034ee40efd9a349
Author: Elliotte Rusty Harold <el...@ibiblio.org>
AuthorDate: Mon Oct 14 08:01:45 2024 -0400
Clean up parameters docs
---
.../dependency/analyze/AbstractAnalyzeMojo.java | 48 ++++++----------------
1 file changed, 13 insertions(+), 35 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 35b287ec..3a4b9cd5 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,22 +74,20 @@ 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")
+ @Parameter(defaultValue = "default")
private String analyzer;
/**
* Whether to fail the build if a dependency warning is found.
*/
- @Parameter(property = "failOnWarning", defaultValue = "false")
+ @Parameter(defaultValue = "false")
private boolean failOnWarning;
/**
* Output used dependencies.
*/
- @Parameter(property = "verbose", defaultValue = "false")
+ @Parameter(defaultValue = "false")
private boolean verbose;
/**
@@ -97,7 +95,7 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo {
* <p>
* <code><b>Non-test scoped</b></code> list will be not affected.
*/
- @Parameter(property = "ignoreNonCompile", defaultValue = "false")
+ @Parameter(defaultValue = "false")
private boolean ignoreNonCompile;
/**
@@ -105,7 +103,7 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo {
*
* @since 3.2.0
*/
- @Parameter(property = "ignoreUnusedRuntime", defaultValue = "false")
+ @Parameter(defaultValue = "false")
private boolean ignoreUnusedRuntime;
/**
@@ -114,47 +112,37 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo {
* the <i>Non-test scoped test only dependencies found</i> warning to the
* <code><ignoredNonTestScopedDependencies></code> configuration.
*
- * @since 3.3.1-SNAPSHOT
+ * @since 3.3.1
*/
- @Parameter(property = "ignoreAllNonTestScoped", defaultValue = "false")
+ @Parameter(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")
+ @Parameter(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")
+ @Parameter(defaultValue = "false")
private boolean scriptableOutput;
/**
* Flag to use for scriptable output.
- *
- * @since 2.0-alpha-5
*/
- @Parameter(property = "scriptableFlag", defaultValue = "$$$%%%")
+ @Parameter(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 folder.
*/
@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> 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[] ignoredUnusedDeclaredDependencies = new String[0];