[sling-org-apache-sling-app-cms] branch master updated: Fixing JavaDoc issues

[dk...@apache.org]

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

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


The following commit(s) were added to refs/heads/master by this push:
     new c90b1a0  Fixing JavaDoc issues
c90b1a0 is described below

commit c90b1a0d70d1ab6f9df8dc8abefdc4874a6942fb
Author: Dan Klco <dk...@apache.org>
AuthorDate: Wed May 29 11:58:05 2019 -0500

    Fixing JavaDoc issues
---
 api/src/main/java/org/apache/sling/cms/CurrentUser.java        |  2 +-
 .../main/java/org/apache/sling/cms/FileMetadataExtractor.java  | 10 +++++-----
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/api/src/main/java/org/apache/sling/cms/CurrentUser.java b/api/src/main/java/org/apache/sling/cms/CurrentUser.java
index 6362f20..292e61b 100644
--- a/api/src/main/java/org/apache/sling/cms/CurrentUser.java
+++ b/api/src/main/java/org/apache/sling/cms/CurrentUser.java
@@ -27,7 +27,7 @@ public interface CurrentUser {
      * Gets a collection of all of the groups this user belongs to including
      * containing groups.
      * 
-     * @return
+     * @return the groups the user belongs to
      */
     public Collection<String> getGroups();
 
diff --git a/api/src/main/java/org/apache/sling/cms/FileMetadataExtractor.java b/api/src/main/java/org/apache/sling/cms/FileMetadataExtractor.java
index 54a709e..9e485b6 100644
--- a/api/src/main/java/org/apache/sling/cms/FileMetadataExtractor.java
+++ b/api/src/main/java/org/apache/sling/cms/FileMetadataExtractor.java
@@ -31,9 +31,9 @@ public interface FileMetadataExtractor {
      * Extract the metadata from the specified file and return the resulting
      * metadata
      * 
-     * @param file
+     * @param file the file from which to extract the metadata
      * @return the metadata from the file
-     * @throws IOException
+     * @throws IOException an exception occurs extracting the metadata
      */
     Map<String,Object> extractMetadata(File file) throws IOException;
 
@@ -42,7 +42,7 @@ public interface FileMetadataExtractor {
      * the jcr:content/metadata node of the file resource
      * 
      * @param file the file to extract the metadata from
-     * @throws IOException
+     * @throws IOException an exception occurs updating the metadata
      */
     void updateMetadata(File file) throws IOException;
 
@@ -51,9 +51,9 @@ public interface FileMetadataExtractor {
      * the jcr:content/metadata node of the file resource
      * 
      * @param file the file to extract the metadata from
-     * @param save if true, persist the results, if not leave the changes
+     * @param persist if true, persist the results, if not leave the changes
      *             unpersisted
-     * @throws IOException
+     * @throws IOException an exception occurs updating the metadata
      */
     void updateMetadata(File file, boolean persist) throws IOException;
 }