This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch elharo-patch-1
in repository https://gitbox.apache.org/repos/asf/maven.git
commit c34ee5bc2208fc8977f033e54de83a78673580b5
Author: Elliotte Rusty Harold <elh...@users.noreply.github.com>
AuthorDate: Sun Jul 2 12:01:51 2023 +0000
Rewrite API doc
Noticed this was a unclear and out of date
---
.../java/org/apache/maven/artifact/handler/ArtifactHandler.java | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git
a/maven-artifact/src/main/java/org/apache/maven/artifact/handler/ArtifactHandler.java
b/maven-artifact/src/main/java/org/apache/maven/artifact/handler/ArtifactHandler.java
index 51c7c51d2..2e7c80963 100644
---
a/maven-artifact/src/main/java/org/apache/maven/artifact/handler/ArtifactHandler.java
+++
b/maven-artifact/src/main/java/org/apache/maven/artifact/handler/ArtifactHandler.java
@@ -19,7 +19,7 @@
package org.apache.maven.artifact.handler;
/**
- * An artifact handler defines for a dependency type, defined as Plexus
role:<ul>
+ * An artifact handler provides metadata for an artifact derived from the
dependency element that references the artifact:<ul>
* <li>extension and classifier, to be able to download the file,</li>
* <li>information on how to use the artifact: whether to add it to the
classpath, or to take into account its
* dependencies.</li>
@@ -32,7 +32,8 @@ public interface ArtifactHandler {
String ROLE = ArtifactHandler.class.getName();
/**
- * Get the file extension associated to the file represented by the
dependency type.
+ * Returns the file name extension used for dependencies of that type;
+ * e.g. "jar", "pom", "xml", etc.
*
* @return the file extension
*/
@@ -41,7 +42,7 @@ public interface ArtifactHandler {
String getDirectory();
/**
- * Get the classifier associated to the dependency type.
+ * Returns the classifier of the dependency.
*
* @return the classifier
*/
