[sling-org-apache-sling-feature-io] branch master updated: Add some missing 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-io.git


The following commit(s) were added to refs/heads/master by this push:
     new ce2d47f  Add some missing Javadoc
ce2d47f is described below

commit ce2d47fe472b6d0dc11f152670141a1e92ded06f
Author: David Bosschaert <bo...@adobe.com>
AuthorDate: Sat May 5 20:15:51 2018 +0100

    Add some missing Javadoc
---
 .../java/org/apache/sling/feature/io/json/FeatureJSONReader.java     | 2 ++
 src/main/java/org/apache/sling/feature/io/json/JSONReaderBase.java   | 2 ++
 src/main/java/org/apache/sling/feature/io/json/JSONWriterBase.java   | 5 ++---
 3 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/src/main/java/org/apache/sling/feature/io/json/FeatureJSONReader.java b/src/main/java/org/apache/sling/feature/io/json/FeatureJSONReader.java
index 0d21598..035089e 100644
--- a/src/main/java/org/apache/sling/feature/io/json/FeatureJSONReader.java
+++ b/src/main/java/org/apache/sling/feature/io/json/FeatureJSONReader.java
@@ -54,6 +54,7 @@ public class FeatureJSONReader extends JSONReaderBase {
      *
      * @param reader The reader for the feature
      * @param location Optional location
+     * @param phase If variables need to be substituted, the phase the this should be done for.
      * @return The read feature
      * @throws IOException If an IO errors occurs or the JSON is invalid.
      */
@@ -69,6 +70,7 @@ public class FeatureJSONReader extends JSONReaderBase {
      * @param reader The reader for the feature
      * @param providedId Optional artifact id
      * @param location Optional location
+     * @param phase If variables need to be substituted, the phase the this should be done for.
      * @return The read feature
      * @throws IOException If an IO errors occurs or the JSON is invalid.
      */
diff --git a/src/main/java/org/apache/sling/feature/io/json/JSONReaderBase.java b/src/main/java/org/apache/sling/feature/io/json/JSONReaderBase.java
index fe3b89e..cefad18 100644
--- a/src/main/java/org/apache/sling/feature/io/json/JSONReaderBase.java
+++ b/src/main/java/org/apache/sling/feature/io/json/JSONReaderBase.java
@@ -88,6 +88,8 @@ abstract class JSONReaderBase {
     }
 
     /** Get the JSON object as a map, removing all comments that start with a '#' character
+     * @param json The JSON object to process
+     * @return A map representing the JSON object.
      */
     protected Map<String, Object> getJsonMap(JsonObject json) {
         @SuppressWarnings("unchecked")
diff --git a/src/main/java/org/apache/sling/feature/io/json/JSONWriterBase.java b/src/main/java/org/apache/sling/feature/io/json/JSONWriterBase.java
index ff502af..cfb6d9b 100644
--- a/src/main/java/org/apache/sling/feature/io/json/JSONWriterBase.java
+++ b/src/main/java/org/apache/sling/feature/io/json/JSONWriterBase.java
@@ -108,9 +108,8 @@ abstract class JSONWriterBase {
 
     /**
      * Write the list of configurations into a "configurations" element
-     * @param w The json generator
-     * @param cfgs The list of configurations
-     * @return
+     * @param cfgs The list of configurations.
+     * @return The JSON element containing the configurations.
      */
     protected JsonObject writeConfigurationsMap(final Configurations cfgs) {
         JsonObjectBuilder configObj = Json.createObjectBuilder();

-- 
To stop receiving notification emails like this one, please contact
davidb@apache.org.