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/12/11 11:01:30 UTC

[maven-assembly-plugin] 01/01: improve javadoc

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

hboutemy pushed a commit to branch javadoc
in repository https://gitbox.apache.org/repos/asf/maven-assembly-plugin.git

commit fab87a041608835d78145118b4b85e1d4b2c523a
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Sun Dec 11 12:01:21 2022 +0100

    improve javadoc
---
 .../maven/plugins/assembly/filter/ComponentsXmlArchiverFileFilter.java  | 2 +-
 .../apache/maven/plugins/assembly/filter/MetaInfServicesHandler.java    | 2 +-
 .../org/apache/maven/plugins/assembly/filter/MetaInfSpringHandler.java  | 2 +-
 .../plugins/assembly/filter/SimpleAggregatingDescriptorHandler.java     | 2 +-
 src/main/java/org/apache/maven/plugins/assembly/io/URLLocation.java     | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/src/main/java/org/apache/maven/plugins/assembly/filter/ComponentsXmlArchiverFileFilter.java b/src/main/java/org/apache/maven/plugins/assembly/filter/ComponentsXmlArchiverFileFilter.java
index 215d51e0..83936fce 100644
--- a/src/main/java/org/apache/maven/plugins/assembly/filter/ComponentsXmlArchiverFileFilter.java
+++ b/src/main/java/org/apache/maven/plugins/assembly/filter/ComponentsXmlArchiverFileFilter.java
@@ -45,7 +45,7 @@ import java.util.List;
 import java.util.Map;
 
 /**
- * Components XML file filter.
+ * <code>plexus</code>: Plexus Components XML file filter <code>META-INF/plexus/components.xml</code>.
  *
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
  *
diff --git a/src/main/java/org/apache/maven/plugins/assembly/filter/MetaInfServicesHandler.java b/src/main/java/org/apache/maven/plugins/assembly/filter/MetaInfServicesHandler.java
index 6bb45a85..3caf1e6b 100644
--- a/src/main/java/org/apache/maven/plugins/assembly/filter/MetaInfServicesHandler.java
+++ b/src/main/java/org/apache/maven/plugins/assembly/filter/MetaInfServicesHandler.java
@@ -26,7 +26,7 @@ import java.nio.file.Paths;
 import org.codehaus.plexus.components.io.fileselectors.FileInfo;
 
 /**
- *
+ * <code>metaInf-services</code>: <code>META-INF/services/*</code> aggregating handler.
  */
 @Named( "metaInf-services" )
 public class MetaInfServicesHandler
diff --git a/src/main/java/org/apache/maven/plugins/assembly/filter/MetaInfSpringHandler.java b/src/main/java/org/apache/maven/plugins/assembly/filter/MetaInfSpringHandler.java
index e004a30e..1bf10723 100644
--- a/src/main/java/org/apache/maven/plugins/assembly/filter/MetaInfSpringHandler.java
+++ b/src/main/java/org/apache/maven/plugins/assembly/filter/MetaInfSpringHandler.java
@@ -24,7 +24,7 @@ import javax.inject.Named;
 import org.codehaus.plexus.components.io.fileselectors.FileInfo;
 
 /**
- *
+ * <code>metaInf-spring</code>: Spring's <code>META-INF/spring.*</code> aggregating handler.
  */
 @Named( "metaInf-spring" )
 public class MetaInfSpringHandler
diff --git a/src/main/java/org/apache/maven/plugins/assembly/filter/SimpleAggregatingDescriptorHandler.java b/src/main/java/org/apache/maven/plugins/assembly/filter/SimpleAggregatingDescriptorHandler.java
index 65c98883..4a4d2e79 100644
--- a/src/main/java/org/apache/maven/plugins/assembly/filter/SimpleAggregatingDescriptorHandler.java
+++ b/src/main/java/org/apache/maven/plugins/assembly/filter/SimpleAggregatingDescriptorHandler.java
@@ -44,7 +44,7 @@ import java.util.Date;
 import java.util.List;
 
 /**
- *
+ * <code>file-aggregator</code>: Generic aggregating handler, configured with filePattern and outputPath.
  */
 @Named( "file-aggregator" )
 public class SimpleAggregatingDescriptorHandler implements ContainerDescriptorHandler
diff --git a/src/main/java/org/apache/maven/plugins/assembly/io/URLLocation.java b/src/main/java/org/apache/maven/plugins/assembly/io/URLLocation.java
index d745a20d..9c3ebca5 100644
--- a/src/main/java/org/apache/maven/plugins/assembly/io/URLLocation.java
+++ b/src/main/java/org/apache/maven/plugins/assembly/io/URLLocation.java
@@ -26,7 +26,7 @@ import java.net.URL;
 import org.apache.commons.io.IOUtils;
 
 /**
- * The URL Location.
+ * The URL Location, storing the URL content to a temporary local file.
  *
  */
 class URLLocation