Skip to content

Copy edit parameter descriptions #1488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
elharo merged 1 commit into from
Jun 18, 2025
Merged

Copy edit parameter descriptions #1488

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 10 additions & 12 deletions ...va/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
import org.sonatype.plexus.build.incremental.BuildContext;

/**
* Class that encapsulates the plugin parameters, and contains methods that handle dependency filtering
* Class that encapsulates the plugin parameters, and contains methods that handle dependency filtering.
*
* @author <a href="mailto:brianf@apache.org">Brian Fox</a>
* @see org.apache.maven.plugins.dependency.AbstractDependencyMojo
Expand Down Expand Up @@ -96,15 +96,15 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected boolean excludeTransitive;

/**
* Comma Separated list of Types to include. Empty String indicates include everything (default).
* Comma-separated list of Types to include. Empty String indicates include everything (default).
*
* @since 2.0
*/
@Parameter(property = "includeTypes", defaultValue = "")
protected String includeTypes;

/**
* Comma Separated list of Types to exclude. Empty String indicates don't exclude anything (default).
* Comma-separated list of Types to exclude. Empty String indicates don't exclude anything (default).
*
* @since 2.0
*/
Expand Down Expand Up @@ -150,15 +150,15 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected String excludeScope;

/**
* Comma Separated list of Classifiers to include. Empty String indicates include everything (default).
* Comma-separated list of Classifiers to include. Empty string indicates include everything (default).
*
* @since 2.0
*/
@Parameter(property = "includeClassifiers", defaultValue = "")
protected String includeClassifiers;

/**
* Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
* Comma-separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
*
* @since 2.0
*/
Expand All @@ -182,31 +182,31 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
protected String type;

/**
* Comma separated list of Artifact names to exclude.
* Comma-separated list of artifact IDs to exclude.
*
* @since 2.0
*/
@Parameter(property = "excludeArtifactIds", defaultValue = "")
protected String excludeArtifactIds;

/**
* Comma separated list of Artifact names to include. Empty String indicates include everything (default).
* Comma-separated list of artifact IDs to include. Empty String indicates include everything (default).
*
* @since 2.0
*/
@Parameter(property = "includeArtifactIds", defaultValue = "")
protected String includeArtifactIds;

/**
* Comma separated list of GroupId Names to exclude.
* Comma-separated list of group IDs to exclude.
*
* @since 2.0
*/
@Parameter(property = "excludeGroupIds", defaultValue = "")
protected String excludeGroupIds;

/**
* Comma separated list of GroupIds to include. Empty String indicates include everything (default).
* Comma-separated list of group IDs to include. Empty string indicates include everything (default).
*
* @since 2.0
*/
Expand All @@ -218,15 +218,13 @@ public abstract class AbstractDependencyFilterMojo extends AbstractDependencyMoj
*
* @since 2.0
*/
// CHECKSTYLE_OFF: LineLength
@Parameter(
property = "markersDirectory",
defaultValue = "${project.build.directory}/dependency-maven-plugin-markers")
// CHECKSTYLE_ON: LineLength
protected File markersDirectory;

/**
* Prepend the groupId during copy.
* Prepend the group ID during copy.
*
* @since 2.2
*/
Expand Down