You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2022/01/08 15:04:00 UTC

[maven] branch master updated: [MNG-7267] update artifact handlers documentation

This is an automated email from the ASF dual-hosted git repository.

hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven.git


The following commit(s) were added to refs/heads/master by this push:
     new f30a0ab  [MNG-7267] update artifact handlers documentation
f30a0ab is described below

commit f30a0ab4dd9bb3bc15c8b46a153fbba92a684dfe
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Sat Jan 8 16:03:57 2022 +0100

    [MNG-7267] update artifact handlers documentation
---
 .../maven/artifact/handler/providers/EarArtifactHandlerProvider.java   | 3 +++
 .../maven/artifact/handler/providers/EjbArtifactHandlerProvider.java   | 3 +++
 .../artifact/handler/providers/EjbClientArtifactHandlerProvider.java   | 3 +++
 .../maven/artifact/handler/providers/JarArtifactHandlerProvider.java   | 3 +++
 .../artifact/handler/providers/JavaSourceArtifactHandlerProvider.java  | 3 +++
 .../artifact/handler/providers/JavadocArtifactHandlerProvider.java     | 3 +++
 .../artifact/handler/providers/MavenPluginArtifactHandlerProvider.java | 3 +++
 .../maven/artifact/handler/providers/PomArtifactHandlerProvider.java   | 3 +++
 .../maven/artifact/handler/providers/RarArtifactHandlerProvider.java   | 3 +++
 .../artifact/handler/providers/TestJarArtifactHandlerProvider.java     | 3 +++
 .../maven/artifact/handler/providers/WarArtifactHandlerProvider.java   | 3 +++
 maven-core/src/site/apt/artifact-handlers.apt                          | 2 +-
 12 files changed, 34 insertions(+), 1 deletion(-)

diff --git a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/EarArtifactHandlerProvider.java b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/EarArtifactHandlerProvider.java
index 57a582d..fbb5fff 100644
--- a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/EarArtifactHandlerProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/EarArtifactHandlerProvider.java
@@ -27,6 +27,9 @@ import javax.inject.Singleton;
 import org.apache.maven.artifact.handler.ArtifactHandler;
 import org.apache.maven.artifact.handler.DefaultArtifactHandler;
 
+/**
+ * {@code ear} artifact handler provider.
+ */
 @Named( "ear" )
 @Singleton
 public class EarArtifactHandlerProvider
diff --git a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/EjbArtifactHandlerProvider.java b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/EjbArtifactHandlerProvider.java
index fb5bfaa..5802db6 100644
--- a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/EjbArtifactHandlerProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/EjbArtifactHandlerProvider.java
@@ -27,6 +27,9 @@ import javax.inject.Singleton;
 import org.apache.maven.artifact.handler.ArtifactHandler;
 import org.apache.maven.artifact.handler.DefaultArtifactHandler;
 
+/**
+ * {@code ejb} artifact handler provider.
+ */
 @Named( "ejb" )
 @Singleton
 public class EjbArtifactHandlerProvider
diff --git a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/EjbClientArtifactHandlerProvider.java b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/EjbClientArtifactHandlerProvider.java
index 86a224d..d225b76 100644
--- a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/EjbClientArtifactHandlerProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/EjbClientArtifactHandlerProvider.java
@@ -27,6 +27,9 @@ import javax.inject.Singleton;
 import org.apache.maven.artifact.handler.ArtifactHandler;
 import org.apache.maven.artifact.handler.DefaultArtifactHandler;
 
+/**
+ * {@code ejb-client} artifact handler provider.
+ */
 @Named( "ejb-client" )
 @Singleton
 public class EjbClientArtifactHandlerProvider
diff --git a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/JarArtifactHandlerProvider.java b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/JarArtifactHandlerProvider.java
index ed69ccb..0e203ba 100644
--- a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/JarArtifactHandlerProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/JarArtifactHandlerProvider.java
@@ -27,6 +27,9 @@ import javax.inject.Singleton;
 import org.apache.maven.artifact.handler.ArtifactHandler;
 import org.apache.maven.artifact.handler.DefaultArtifactHandler;
 
+/**
+ * {@code jar} artifact handler provider.
+ */
 @Named( "jar" )
 @Singleton
 public class JarArtifactHandlerProvider
diff --git a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/JavaSourceArtifactHandlerProvider.java b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/JavaSourceArtifactHandlerProvider.java
index 8d0d034..37bf394 100644
--- a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/JavaSourceArtifactHandlerProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/JavaSourceArtifactHandlerProvider.java
@@ -27,6 +27,9 @@ import javax.inject.Singleton;
 import org.apache.maven.artifact.handler.ArtifactHandler;
 import org.apache.maven.artifact.handler.DefaultArtifactHandler;
 
+/**
+ * {@code java-source} artifact handler provider.
+ */
 @Named( "java-source" )
 @Singleton
 public class JavaSourceArtifactHandlerProvider
diff --git a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/JavadocArtifactHandlerProvider.java b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/JavadocArtifactHandlerProvider.java
index 82f7fce..d7d40e3 100644
--- a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/JavadocArtifactHandlerProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/JavadocArtifactHandlerProvider.java
@@ -27,6 +27,9 @@ import javax.inject.Singleton;
 import org.apache.maven.artifact.handler.ArtifactHandler;
 import org.apache.maven.artifact.handler.DefaultArtifactHandler;
 
+/**
+ * {@code javadoc} artifact handler provider.
+ */
 @Named( "javadoc" )
 @Singleton
 public class JavadocArtifactHandlerProvider
diff --git a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/MavenPluginArtifactHandlerProvider.java b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/MavenPluginArtifactHandlerProvider.java
index 4b1a89f..c712211 100644
--- a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/MavenPluginArtifactHandlerProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/MavenPluginArtifactHandlerProvider.java
@@ -27,6 +27,9 @@ import javax.inject.Singleton;
 import org.apache.maven.artifact.handler.ArtifactHandler;
 import org.apache.maven.artifact.handler.DefaultArtifactHandler;
 
+/**
+ * {@code maven-plugin} artifact handler provider.
+ */
 @Named( "maven-plugin" )
 @Singleton
 public class MavenPluginArtifactHandlerProvider
diff --git a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/PomArtifactHandlerProvider.java b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/PomArtifactHandlerProvider.java
index 92bd813..3696159 100644
--- a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/PomArtifactHandlerProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/PomArtifactHandlerProvider.java
@@ -27,6 +27,9 @@ import javax.inject.Singleton;
 import org.apache.maven.artifact.handler.ArtifactHandler;
 import org.apache.maven.artifact.handler.DefaultArtifactHandler;
 
+/**
+ * {@code pom} artifact handler provider.
+ */
 @Named( "pom" )
 @Singleton
 public class PomArtifactHandlerProvider
diff --git a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/RarArtifactHandlerProvider.java b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/RarArtifactHandlerProvider.java
index a8b8cac..d2d75b9 100644
--- a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/RarArtifactHandlerProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/RarArtifactHandlerProvider.java
@@ -27,6 +27,9 @@ import javax.inject.Singleton;
 import org.apache.maven.artifact.handler.ArtifactHandler;
 import org.apache.maven.artifact.handler.DefaultArtifactHandler;
 
+/**
+ * {@code rar} artifact handler provider.
+ */
 @Named( "rar" )
 @Singleton
 public class RarArtifactHandlerProvider
diff --git a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/TestJarArtifactHandlerProvider.java b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/TestJarArtifactHandlerProvider.java
index 1aa1b93..57bfe49 100644
--- a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/TestJarArtifactHandlerProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/TestJarArtifactHandlerProvider.java
@@ -27,6 +27,9 @@ import javax.inject.Singleton;
 import org.apache.maven.artifact.handler.ArtifactHandler;
 import org.apache.maven.artifact.handler.DefaultArtifactHandler;
 
+/**
+ * {@code test-jar} artifact handler provider.
+ */
 @Named( "test-jar" )
 @Singleton
 public class TestJarArtifactHandlerProvider
diff --git a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/WarArtifactHandlerProvider.java b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/WarArtifactHandlerProvider.java
index 3b119d9..f2dc46e 100644
--- a/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/WarArtifactHandlerProvider.java
+++ b/maven-core/src/main/java/org/apache/maven/artifact/handler/providers/WarArtifactHandlerProvider.java
@@ -27,6 +27,9 @@ import javax.inject.Singleton;
 import org.apache.maven.artifact.handler.ArtifactHandler;
 import org.apache.maven.artifact.handler.DefaultArtifactHandler;
 
+/**
+ * {@code war} artifact handler provider.
+ */
 @Named( "war" )
 @Singleton
 public class WarArtifactHandlerProvider
diff --git a/maven-core/src/site/apt/artifact-handlers.apt b/maven-core/src/site/apt/artifact-handlers.apt
index 299d7d8..5e3be04 100644
--- a/maven-core/src/site/apt/artifact-handlers.apt
+++ b/maven-core/src/site/apt/artifact-handlers.apt
@@ -30,7 +30,7 @@ Default Artifact Handlers Reference
   (classifier, extension, language) and how to manage it as dependency (add to classpath, include dependencies).
 
   Some artifact handlers
-  are configured by default in <<<META-INF/plexus/artifact-handlers.xml>>>:
+  are configured by default in {{{./apidocs/org/apache/maven/artifact/handler/providers/package-summary.html}<<<org.apache.maven.artifact.handler.providers>>>}} package:
 
 *--------------------+---------------+------------+------------+-----------+---------------------+-----------------------+
 || type              || classifier   || extension || packaging || language || added to classpath || includesDependencies ||