[sling-org-apache-sling-repoinit-parser] branch master updated: Fix up JavaDoc in preparation for release

[davidb]

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-repoinit-parser.git


The following commit(s) were added to refs/heads/master by this push:
     new c7298be  Fix up JavaDoc in preparation for release
c7298be is described below

commit c7298beb55bc471f86193ef0f38f91f76a778c31
Author: David Bosschaert <bossc...@adobe.com>
AuthorDate: Fri Feb 5 13:52:44 2021 +0000

    Fix up JavaDoc in preparation for release
---
 src/main/java/org/apache/sling/repoinit/parser/RepoInitParser.java    | 1 +
 .../java/org/apache/sling/repoinit/parser/operations/AclLine.java     | 1 +
 .../java/org/apache/sling/repoinit/parser/operations/CreateGroup.java | 2 +-
 .../java/org/apache/sling/repoinit/parser/operations/CreateUser.java  | 2 +-
 .../org/apache/sling/repoinit/parser/operations/PropertyLine.java     | 4 +++-
 5 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/src/main/java/org/apache/sling/repoinit/parser/RepoInitParser.java 
b/src/main/java/org/apache/sling/repoinit/parser/RepoInitParser.java
index f6db001..b0aa148 100644
--- a/src/main/java/org/apache/sling/repoinit/parser/RepoInitParser.java
+++ b/src/main/java/org/apache/sling/repoinit/parser/RepoInitParser.java
@@ -34,6 +34,7 @@ public interface RepoInitParser {
      * Parse the supplied input.
      *
      * @param reader Input in repoinit format. The reader is closed by this 
method.
+     * @return The parsed result.
      * @throws RepoInitParsingException on parsing errors
      */
     List<Operation> parse(Reader reader) throws RepoInitParsingException;
diff --git 
a/src/main/java/org/apache/sling/repoinit/parser/operations/AclLine.java 
b/src/main/java/org/apache/sling/repoinit/parser/operations/AclLine.java
index 6fe7108..73d434e 100644
--- a/src/main/java/org/apache/sling/repoinit/parser/operations/AclLine.java
+++ b/src/main/java/org/apache/sling/repoinit/parser/operations/AclLine.java
@@ -56,6 +56,7 @@ public class AclLine {
      * Return the named multi-value property, or an empty list if not found.
      * 
      * @param name the property to get the value of
+     * @return the value of the property.
      */
     public List<String> getProperty(String name) {
         List<String> value = properties.get(name);
diff --git 
a/src/main/java/org/apache/sling/repoinit/parser/operations/CreateGroup.java 
b/src/main/java/org/apache/sling/repoinit/parser/operations/CreateGroup.java
index 83c09ed..1bcfb9d 100644
--- a/src/main/java/org/apache/sling/repoinit/parser/operations/CreateGroup.java
+++ b/src/main/java/org/apache/sling/repoinit/parser/operations/CreateGroup.java
@@ -35,7 +35,7 @@ public class CreateGroup extends OperationWithPathOptions {
      * Operation that creates a group.
      * 
      * @param groupname the name of the group to create
-     * @param path     optional path
+     * @param wph       optional path
      */
     public CreateGroup(String groupname, WithPathOptions wph) {
         super(wph);
diff --git 
a/src/main/java/org/apache/sling/repoinit/parser/operations/CreateUser.java 
b/src/main/java/org/apache/sling/repoinit/parser/operations/CreateUser.java
index 04aeade..6060d30 100644
--- a/src/main/java/org/apache/sling/repoinit/parser/operations/CreateUser.java
+++ b/src/main/java/org/apache/sling/repoinit/parser/operations/CreateUser.java
@@ -37,7 +37,7 @@ public class CreateUser extends OperationWithPathOptions {
      * @param username the name of the user to create
      * @param passwordEncoding optional encoding for the supplied password
      * @param password optional password
-     * @param path optional path
+     * @param wpopt optional path
      */
     public CreateUser(String username, String passwordEncoding, String 
password, WithPathOptions wpopt) {
         super(wpopt);
diff --git 
a/src/main/java/org/apache/sling/repoinit/parser/operations/PropertyLine.java 
b/src/main/java/org/apache/sling/repoinit/parser/operations/PropertyLine.java
index 337cfd1..6bc5156 100644
--- 
a/src/main/java/org/apache/sling/repoinit/parser/operations/PropertyLine.java
+++ 
b/src/main/java/org/apache/sling/repoinit/parser/operations/PropertyLine.java
@@ -49,6 +49,8 @@ public class PropertyLine {
      *  @param name  name of the property
      *  @param typeString property type, as a String
      *  @param values  values of the property
+     *  @param isDefault true if this line is a "default" as opposed to a 
"set" instruction
+     *  @throws ParseException if the line cannot be parsed.
      */
     public PropertyLine(String name, String typeString, List<String> values, 
boolean isDefault) throws ParseException {
         this.name = name;
@@ -141,4 +143,4 @@ public class PropertyLine {
         sb.append("]");
         return sb.toString();
     }
-}
\ No newline at end of file
+}