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 f164515f grammar and jacdoc fixes (#1491)
f164515f is described below
commit f164515f2fd9649b5e5f818b53fc5b238b8d5deb
Author: Elliotte Rusty Harold <[email protected]>
AuthorDate: Sun Jul 6 10:46:55 2025 -0400
grammar and jacdoc fixes (#1491)
* grammar
* more
---
.../pom.xml | 4 +-
.../dependency/fromConfiguration/ArtifactItem.java | 74 +++++++++++-----------
.../AbstractDependencyFilterMojo.java | 2 +-
.../AbstractFromDependenciesMojo.java | 4 +-
.../fromDependencies/CopyDependenciesMojo.java | 22 +++----
.../dependency/tree/JsonDependencyNodeVisitor.java | 2 +-
.../plugins/dependency/utils/DependencyUtil.java | 17 +++--
7 files changed, 62 insertions(+), 63 deletions(-)
diff --git a/src/it/projects/mdep-689-apply-filtering-go-offline-goal/pom.xml
b/src/it/projects/mdep-689-apply-filtering-go-offline-goal/pom.xml
index a41847d9..0fee5f39 100644
--- a/src/it/projects/mdep-689-apply-filtering-go-offline-goal/pom.xml
+++ b/src/it/projects/mdep-689-apply-filtering-go-offline-goal/pom.xml
@@ -95,8 +95,8 @@ under the License.
<configuration>
<excludeGroupIds>skip.this.groupid,skip.this.groupid.too</excludeGroupIds>
<excludeArtifactIds>skip-this-artifact,skip-this-artifact-too</excludeArtifactIds>
- <!-- the maven-common-artifact-filters library does not support
comma delimited
- scope exclusions. only one at a time. the other filters support
comma delimited lists-->
+ <!-- The maven-common-artifact-filters library does not support
comma-delimited
+ scope exclusions, only one at a time. The other filters support
comma-delimited lists. -->
<!-- <excludeScope>compile,system</excludeScope> -->
<excludeScope>system</excludeScope>
<excludeTypes>ear</excludeTypes>
diff --git
a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java
b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java
index b98b4567..ff093978 100644
---
a/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java
+++
b/src/main/java/org/apache/maven/plugins/dependency/fromConfiguration/ArtifactItem.java
@@ -36,37 +36,37 @@ import
org.codehaus.plexus.components.io.filemappers.FileMapper;
*/
public class ArtifactItem implements DependableCoordinate {
/**
- * Group ID of Artifact
+ * Group ID of artifact
*/
@Parameter(required = true)
private String groupId;
/**
- * Name of Artifact
+ * Name of artifact
*/
@Parameter(required = true)
private String artifactId;
/**
- * Version of Artifact
+ * Version of artifact
*/
@Parameter
private String version = null;
/**
- * Type of Artifact (War,Jar,etc)
+ * Type of artifact (War, Jar, etc.)
*/
@Parameter(required = true)
private String type = "jar";
/**
- * Classifier for Artifact (tests,sources,etc)
+ * Classifier for artifact (tests, sources, etc.)
*/
@Parameter
private String classifier;
/**
- * Location to use for this Artifact. Overrides default location.
+ * Location to use for this artifact. Overrides default location.
*/
@Parameter
private File outputDirectory;
@@ -78,7 +78,7 @@ public class ArtifactItem implements DependableCoordinate {
private String destFileName;
/**
- * Force Overwrite..this is the one to set in pom
+ * Force Overwrite. This is the one to set in pom.
*/
private String overWrite;
@@ -114,7 +114,7 @@ public class ArtifactItem implements DependableCoordinate {
private FileMapper[] fileMappers;
/**
- * Default ctor.
+ * Default constructor.
*/
public ArtifactItem() {
// default constructor
@@ -140,7 +140,7 @@ public class ArtifactItem implements DependableCoordinate {
}
/**
- * @return Returns the artifactId.
+ * @return returns the artifact ID
*/
@Override
public String getArtifactId() {
@@ -148,14 +148,14 @@ public class ArtifactItem implements DependableCoordinate
{
}
/**
- * @param theArtifact The artifactId to set.
+ * @param theArtifact the artifact ID to set
*/
public void setArtifactId(String theArtifact) {
this.artifactId = filterEmptyString(theArtifact);
}
/**
- * @return Returns the groupId.
+ * @return returns the group ID
*/
@Override
public String getGroupId() {
@@ -163,14 +163,14 @@ public class ArtifactItem implements DependableCoordinate
{
}
/**
- * @param groupId The groupId to set.
+ * @param groupId the group ID to set
*/
public void setGroupId(String groupId) {
this.groupId = filterEmptyString(groupId);
}
/**
- * @return Returns the type.
+ * @return returns the type
*/
@Override
public String getType() {
@@ -178,14 +178,14 @@ public class ArtifactItem implements DependableCoordinate
{
}
/**
- * @param type The type to set.
+ * @param type the type to set
*/
public void setType(String type) {
this.type = filterEmptyString(type);
}
/**
- * @return Returns the version.
+ * @return returns the version
*/
@Override
public String getVersion() {
@@ -193,21 +193,21 @@ public class ArtifactItem implements DependableCoordinate
{
}
/**
- * @param version The version to set.
+ * @param version the version to set
*/
public void setVersion(String version) {
this.version = filterEmptyString(version);
}
/**
- * @return Returns the base version.
+ * @return teturns the base version
*/
public String getBaseVersion() {
return ArtifactUtils.toSnapshotVersion(version);
}
/**
- * @return Classifier.
+ * @return Classifier
*/
@Override
public String getClassifier() {
@@ -215,7 +215,7 @@ public class ArtifactItem implements DependableCoordinate {
}
/**
- * @param classifier Classifier.
+ * @param classifier classifier
*/
public void setClassifier(String classifier) {
this.classifier = filterEmptyString(classifier);
@@ -231,63 +231,63 @@ public class ArtifactItem implements DependableCoordinate
{
}
/**
- * @return Returns the location.
+ * @return returns the location
*/
public File getOutputDirectory() {
return outputDirectory;
}
/**
- * @param outputDirectory The outputDirectory to set.
+ * @param outputDirectory the outputDirectory to set
*/
public void setOutputDirectory(File outputDirectory) {
this.outputDirectory = outputDirectory;
}
/**
- * @return Returns the location.
+ * @return returns the location
*/
public String getDestFileName() {
return destFileName;
}
/**
- * @param destFileName The destFileName to set.
+ * @param destFileName the destination file name to set
*/
public void setDestFileName(String destFileName) {
this.destFileName = filterEmptyString(destFileName);
}
/**
- * @return Returns the needsProcessing.
+ * @return returns the needsProcessing
*/
public boolean isNeedsProcessing() {
return this.needsProcessing;
}
/**
- * @param needsProcessing The needsProcessing to set.
+ * @param needsProcessing the needsProcessing to set
*/
public void setNeedsProcessing(boolean needsProcessing) {
this.needsProcessing = needsProcessing;
}
/**
- * @return Returns the overWriteSnapshots.
+ * @return teturns the overWriteSnapshots
*/
public String getOverWrite() {
return this.overWrite;
}
/**
- * @param overWrite The overWrite to set.
+ * @param overWrite the overWrite to set
*/
public void setOverWrite(String overWrite) {
this.overWrite = overWrite;
}
/**
- * @return Returns the encoding.
+ * @return returns the encoding
* @since 3.0
*/
public String getEncoding() {
@@ -295,7 +295,7 @@ public class ArtifactItem implements DependableCoordinate {
}
/**
- * @param encoding The encoding to set.
+ * @param encoding the encoding to set
* @since 3.0
*/
public void setEncoding(String encoding) {
@@ -303,42 +303,42 @@ public class ArtifactItem implements DependableCoordinate
{
}
/**
- * @return Returns the artifact.
+ * @return returns the artifact
*/
public Artifact getArtifact() {
return this.artifact;
}
/**
- * @param artifact The artifact to set.
+ * @param artifact the artifact to set
*/
public void setArtifact(Artifact artifact) {
this.artifact = artifact;
}
/**
- * @return Returns a comma separated list of excluded items
+ * @return returns a comma separated list of excluded items
*/
public String getExcludes() {
return DependencyUtil.cleanToBeTokenizedString(this.excludes);
}
/**
- * @param excludes A comma separated list of items to exclude i.e.
<code>**\/*.xml, **\/*.properties</code>
+ * @param excludes a comma separated list of items to exclude; for
example, <code>**\/*.xml, **\/*.properties</code>
*/
public void setExcludes(String excludes) {
this.excludes = excludes;
}
/**
- * @return Returns a comma separated list of included items
+ * @return returns a comma separated list of items to include
*/
public String getIncludes() {
return DependencyUtil.cleanToBeTokenizedString(this.includes);
}
/**
- * @param includes A comma separated list of items to include i.e.
<code>**\/*.xml, **\/*.properties</code>
+ * @param includes comma separated list of items to include; for example,
<code>**\/*.xml, **\/*.properties</code>
*/
public void setIncludes(String includes) {
this.includes = includes;
@@ -346,7 +346,7 @@ public class ArtifactItem implements DependableCoordinate {
/**
* @return {@link FileMapper}s to be used for rewriting each target path,
or {@code null} if no rewriting shall
- * happen.
+ * happen
*
* @since 3.1.2
*/
@@ -356,7 +356,7 @@ public class ArtifactItem implements DependableCoordinate {
/**
* @param fileMappers {@link FileMapper}s to be used for rewriting each
target path, or {@code null} if no
- * rewriting shall happen.
+ * rewriting shall happen
*
* @since 3.1.2
*/
diff --git
a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
index 9eaa182e..3b274c5f 100644
---
a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
+++
b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
@@ -478,7 +478,7 @@ public abstract class AbstractDependencyFilterMojo extends
AbstractDependencyMoj
resolverUtil.resolveArtifact(artifact,
getProject().getRemoteProjectRepositories());
resolvedArtifacts.add(RepositoryUtils.toArtifact(resolveArtifact));
} catch (ArtifactResolutionException ex) {
- // an error occurred during resolution, log it an continue
+ // an error occurred during resolution, log it and continue
getLog().debug("error resolving: " + artifact, ex);
if (stopOnFailure) {
throw new MojoExecutionException("error resolving: " +
artifact, ex);
diff --git
a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractFromDependenciesMojo.java
b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractFromDependenciesMojo.java
index 30516ee3..5f624e7a 100644
---
a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractFromDependenciesMojo.java
+++
b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractFromDependenciesMojo.java
@@ -83,7 +83,7 @@ public abstract class AbstractFromDependenciesMojo extends
AbstractDependencyFil
/**
* Place each type of file in a separate subdirectory. (example
/outputDirectory/runtime /outputDirectory/provided
- * etc)
+ * etc.)
*
* @since 2.2
*/
@@ -91,7 +91,7 @@ public abstract class AbstractFromDependenciesMojo extends
AbstractDependencyFil
protected boolean useSubDirectoryPerScope;
/**
- * Place each type of file in a separate subdirectory. (example
/outputDirectory/jars /outputDirectory/wars etc)
+ * Place each type of file in a separate subdirectory. (example
/outputDirectory/jars /outputDirectory/wars etc.)
*
* @since 2.0-alpha-1
*/
diff --git
a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/CopyDependenciesMojo.java
b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/CopyDependenciesMojo.java
index 0d6eb7d7..8223d95c 100644
---
a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/CopyDependenciesMojo.java
+++
b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/CopyDependenciesMojo.java
@@ -222,11 +222,11 @@ public class CopyDependenciesMojo extends
AbstractFromDependenciesMojo {
* Copies the Artifact after building the destination file name if
overridden. This method also checks if the
* classifier is set and adds it to the destination file name if needed.
*
- * @param artifact representing the object to be copied.
- * @param removeVersion specifies if the version should be removed from
the file name when copying.
- * @param prependGroupId specifies if the groupId should be prepend to the
file while copying.
- * @param theUseBaseVersion specifies if the baseVersion of the artifact
should be used instead of the version.
- * @throws MojoExecutionException with a message if an error occurs.
+ * @param artifact the object to be copied
+ * @param removeVersion specifies if the version should be removed from
the file name when copying
+ * @param prependGroupId specifies if the group ID should be prefixed to
the file while copying
+ * @param theUseBaseVersion specifies if the baseVersion of the artifact
should be used instead of the version
+ * @throws MojoExecutionException with a message if an error occurs
* @see #copyArtifact(Artifact, boolean, boolean, boolean, boolean)
*/
protected void copyArtifact(
@@ -239,12 +239,12 @@ public class CopyDependenciesMojo extends
AbstractFromDependenciesMojo {
* Copies the Artifact after building the destination file name if
overridden. This method also checks if the
* classifier is set and adds it to the destination file name if needed.
*
- * @param artifact representing the object to be copied.
- * @param removeVersion specifies if the version should be removed from
the file name when copying.
- * @param prependGroupId specifies if the groupId should be prepend to the
file while copying.
- * @param useBaseVersion specifies if the baseVersion of the artifact
should be used instead of the version.
- * @param removeClassifier specifies if the classifier should be removed
from the file name when copying.
- * @throws MojoExecutionException with a message if an error occurs.
+ * @param artifact the object to be copied
+ * @param removeVersion specifies if the version should be removed from
the file name when copying
+ * @param prependGroupId specifies if the groupId should be prefixed to
the file while copying
+ * @param useBaseVersion specifies if the baseVersion of the artifact
should be used instead of the version
+ * @param removeClassifier specifies if the classifier should be removed
from the file name when copying
+ * @throws MojoExecutionException with a message if an error occurs
* @see CopyUtil#copyArtifactFile(Artifact, File)
* @see DependencyUtil#getFormattedOutputDirectory(boolean, boolean,
boolean, boolean, boolean, boolean, File, Artifact)
*/
diff --git
a/src/main/java/org/apache/maven/plugins/dependency/tree/JsonDependencyNodeVisitor.java
b/src/main/java/org/apache/maven/plugins/dependency/tree/JsonDependencyNodeVisitor.java
index 015ce1b2..33392821 100644
---
a/src/main/java/org/apache/maven/plugins/dependency/tree/JsonDependencyNodeVisitor.java
+++
b/src/main/java/org/apache/maven/plugins/dependency/tree/JsonDependencyNodeVisitor.java
@@ -84,7 +84,7 @@ public class JsonDependencyNodeVisitor extends
AbstractSerializingVisitor implem
}
}
/**
- * Writes the children of the node to the string builder. And each
children of each node will be written recursively.
+ * Writes the children of the node to the string builder. Each child of
each node will be written recursively.
*
* @param indent the current indent level
* @param node the node to write
diff --git
a/src/main/java/org/apache/maven/plugins/dependency/utils/DependencyUtil.java
b/src/main/java/org/apache/maven/plugins/dependency/utils/DependencyUtil.java
index 5ec05ccd..f0a33379 100644
---
a/src/main/java/org/apache/maven/plugins/dependency/utils/DependencyUtil.java
+++
b/src/main/java/org/apache/maven/plugins/dependency/utils/DependencyUtil.java
@@ -133,17 +133,16 @@ public final class DependencyUtil {
/**
* Formats the outputDirectory based on type.
*
- * @param useSubdirsPerScope if a new sub directory should be used for
each scope.
- * @param useSubdirsPerType if a new sub directory should be used for each
type.
- * @param useSubdirPerArtifact if a new sub directory should be used for
each artifact.
- * @param useRepositoryLayout if dependencies must be moved into a Maven
repository layout, if set, other
- * settings
- * will be ignored.
+ * @param useSubdirsPerScope if a new subdirectory should be used for each
scope
+ * @param useSubdirsPerType if a new subdirectory should be used for each
type
+ * @param useSubdirPerArtifact if a new subdirectory should be used for
each artifact
+ * @param useRepositoryLayout if dependencies must be moved into a Maven
repository layout.
+ * If set, other settings will be ignored.
* @param removeVersion if the version must not be mentioned in the
filename
* @param removeType if the type must not be mentioned in the filename
- * @param outputDirectory base outputDirectory.
- * @param artifact information about the artifact.
- * @return a formatted File object to use for output.
+ * @param outputDirectory base outputDirectory
+ * @param artifact information about the artifact
+ * @return a formatted File object to use for output
*/
public static File getFormattedOutputDirectory(
boolean useSubdirsPerScope,
