From e2d23838c31e7f404227fd1f24b30efc285baf2b Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Tue, 22 Oct 2024 15:43:22 -0400 Subject: [PATCH] Revert "Clean up parameters docs (#439)" This reverts commit 5e4927707de3499d97d48272e0c60bcfc8fcf0ff. --- .../analyze/AbstractAnalyzeMojo.java | 30 ++++++++++++++++--- 1 file changed, 26 insertions(+), 4 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 ba3fb677c..ebff3dcea 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,6 +74,8 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo { * maven-dependency-analyzer 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; @@ -112,37 +114,47 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo { * the Non-test scoped test only dependencies found warning to the * <ignoredNonTestScopedDependencies> configuration. * - * @since 3.3.1 + * @since 3.3.1-SNAPSHOT */ @Parameter(property = "ignoreAllNonTestScoped", defaultValue = "false") private boolean ignoreAllNonTestScoped; /** - * Output XML for the missing dependencies (used but not declared). + * Output the xml for the missing dependencies (used but not declared). + * + * @since 2.0-alpha-5 */ @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; /** - * Base directory for output. + * Flag to use for scriptable output + * + * @since 2.0-alpha-5 */ @Parameter(defaultValue = "${basedir}", readonly = true) private File baseDir; /** - * Target directory. + * Target folder + * + * @since 2.0-alpha-5 */ @Parameter(defaultValue = "${project.build.directory}", readonly = true) private File outputDirectory; @@ -150,12 +162,16 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo { /** * Force dependencies as used, to override incomplete result caused by bytecode-level analysis. Dependency format is * groupId:artifactId. + * + * @since 2.6 */ @Parameter private String[] usedDependencies; /** * Skip plugin execution completely. + * + * @since 2.7 */ @Parameter(property = "mdep.analyze.skip", defaultValue = "false") private boolean skip; @@ -174,6 +190,8 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo { * For example, org.apache.* will match all artifacts whose group id starts with * org.apache., and :::*-SNAPSHOT will match all snapshot artifacts. *

+ * + * @since 2.10 */ @Parameter private String[] ignoredDependencies = new String[0]; @@ -191,6 +209,8 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo { * For example, org.apache.* will match all artifacts whose group id starts with * org.apache., and :::*-SNAPSHOT will match all snapshot artifacts. *

+ * + * @since 2.10 */ @Parameter private String[] ignoredUsedUndeclaredDependencies = new String[0]; @@ -208,6 +228,8 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo { * For example, org.apache.* matches all artifacts whose group id starts with * org.apache., and :::*-SNAPSHOT will match all snapshot artifacts. *

+ * + * @since 2.10 */ @Parameter(defaultValue = "org.slf4j:slf4j-simple::") private String[] ignoredUnusedDeclaredDependencies;