[sling-org-apache-sling-feature] branch master updated: Update Javadoc

[da...@apache.org]

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

davidb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-feature.git


The following commit(s) were added to refs/heads/master by this push:
     new 76fcb8e  Update Javadoc
76fcb8e is described below

commit 76fcb8e788ecfb735255d346f15cb8a2db9ef03d
Author: David Bosschaert <bo...@adobe.com>
AuthorDate: Fri Nov 27 14:32:07 2020 +0000

    Update Javadoc
---
 src/main/java/org/apache/sling/feature/Feature.java                 | 6 ++++--
 src/main/java/org/apache/sling/feature/io/IOUtils.java              | 2 +-
 .../java/org/apache/sling/feature/io/artifacts/ArtifactHandler.java | 2 +-
 3 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/src/main/java/org/apache/sling/feature/Feature.java b/src/main/java/org/apache/sling/feature/Feature.java
index 9fc53d5..d4346b3 100644
--- a/src/main/java/org/apache/sling/feature/Feature.java
+++ b/src/main/java/org/apache/sling/feature/Feature.java
@@ -324,6 +324,7 @@ public class Feature implements Comparable<Feature> {
 
     /**
      * Return a mutable map of metadata for the framework property
+     * @param key The name of the property.
      * @return A mutable map or {@code null} if the framework property does not exist
      * @since 1.7.0
      */
@@ -333,6 +334,7 @@ public class Feature implements Comparable<Feature> {
 
     /**
      * Return a mutable map of metadata for the variable
+     * @param key The name of the variable.
      * @return A mutable map or {@code null} if the variable does not exist
      * @since 1.7.0
      */
@@ -343,7 +345,7 @@ public class Feature implements Comparable<Feature> {
     /**
      * Get the feature origins for the metadata- if recorded
      * 
-     * @param The metadata (for a variable or framework property)
+     * @param metadata The metadata (for a variable or framework property)
      * @return A immutable list of feature artifact ids - list is never empty
      * @since 1.7
      * @throws IllegalArgumentException If the stored values are not valid artifact ids
@@ -365,7 +367,7 @@ public class Feature implements Comparable<Feature> {
 
     /**
      * Set the feature origins for the metadata
-     * @param The metadata (for a variable or framework property)
+     * @param metadata The metadata (for a variable or framework property)
      * @param featureOrigins the list of artifact ids or null to remove the info from this object
      * @since 1.7
      */
diff --git a/src/main/java/org/apache/sling/feature/io/IOUtils.java b/src/main/java/org/apache/sling/feature/io/IOUtils.java
index 297acbe..1ac96c6 100644
--- a/src/main/java/org/apache/sling/feature/io/IOUtils.java
+++ b/src/main/java/org/apache/sling/feature/io/IOUtils.java
@@ -174,7 +174,7 @@ public class IOUtils {
      *              if it can not be presented as a file directly
      * @param tmpDir the tmpDir to use (null for default)
      * @return the file the url points to (or null if none) - or a tmp file if cache is true and the url could be cached
-     * @throws IOException
+     * @throws IOException When an IO Exception occurs.
      */
     public static File getFileFromURL(URL url, boolean cache, File tmpDir) throws IOException {
         File result;
diff --git a/src/main/java/org/apache/sling/feature/io/artifacts/ArtifactHandler.java b/src/main/java/org/apache/sling/feature/io/artifacts/ArtifactHandler.java
index c4d87ce..07ed587 100644
--- a/src/main/java/org/apache/sling/feature/io/artifacts/ArtifactHandler.java
+++ b/src/main/java/org/apache/sling/feature/io/artifacts/ArtifactHandler.java
@@ -44,7 +44,7 @@ public class ArtifactHandler {
      * Create a new handler.
      *
      * @param file The file for the artifact
-     * @throws MalformedURLException
+     * @throws MalformedURLException If the file name cannot be converted to a URL.
      * @since 1.1.0
      */
     public ArtifactHandler(final File file) throws MalformedURLException {