Skip to content

Commit

Permalink
Update API doc
Browse files Browse the repository at this point in the history
  • Loading branch information
elharo committed Oct 14, 2024
1 parent 371efc1 commit 06ea2a2
Showing 1 changed file with 4 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo {
private String[] ignoredUsedUndeclaredDependencies = new String[0];

/**
* List of dependencies that will be ignored if they are declared but unused. The filter syntax is:
* List of dependencies that are ignored if they are declared but unused. The filter syntax is:
*
* <pre>
* [groupId]:[artifactId]:[type]:[version]
Expand All @@ -225,21 +225,17 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo {
* where each pattern segment is optional and supports full and partial <code>*</code> wildcards. An empty pattern
* segment is treated as an implicit wildcard. *
* <p>
* For example, <code>org.apache.*</code> will match all artifacts whose group id starts with
* 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>
* <p>
* By default, org.slf4j:slf4j-simple is ignored. Setting this property to an empty list
* will allow it to be detected.
* </p>
*
* @since 2.10
*/
@Parameter(defaultValue = "org.slf4j:slf4j-simple::")
private String[] ignoredUnusedDeclaredDependencies;

/**
* List of dependencies that will be ignored if they are in not test scope but are only used in test classes.
* List of dependencies that are ignored if they are in not test scope but are only used in test classes.
* The filter syntax is:
*
* <pre>
Expand All @@ -249,13 +245,9 @@ public abstract class AbstractAnalyzeMojo extends AbstractMojo {
* where each pattern segment is optional and supports full and partial <code>*</code> wildcards. An empty pattern
* segment is treated as an implicit wildcard. *
* <p>
* For example, <code>org.apache.*</code> will match all artifacts whose group id starts with
* For example, <code>org.apache.*</code> matched all artifacts whose group id starts with
* <code>org.apache.</code>, and <code>:::*-SNAPSHOT</code> will match all snapshot artifacts.
* </p>
* <p>
* By default, org.slf4j:slf4j-simple is ignored. Setting this property to an empty list
* will allow it to be detected.
* </p>
*
* @since 3.3.0
*/
Expand Down

0 comments on commit 06ea2a2

Please sign in to comment.