svn commit: r1751432 - in /sling/trunk/bundles/api/src/main/java/org/apache/sling/api: resource/path/PathSet.java scripting/SlingBindings.java

[cz...@apache.org]

Author: cziegeler
Date: Tue Jul  5 10:07:10 2016
New Revision: 1751432

URL: http://svn.apache.org/viewvc?rev=1751432&view=rev
Log:
SLING-5821 : Fix javadoc errors and warnings (WiP)

Modified:
    sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathSet.java
    sling/trunk/bundles/api/src/main/java/org/apache/sling/api/scripting/SlingBindings.java

Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathSet.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathSet.java?rev=1751432&r1=1751431&r2=1751432&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathSet.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/path/PathSet.java Tue Jul  5 10:07:10 2016
@@ -125,7 +125,7 @@ public class PathSet implements Iterable
     /**
      * Check whether the provided path is in the sub tree of any
      * of the paths in this set.
-     * @param otherPath
+     * @param otherPath The path to match
      * @return The path which matches the provided path, {@code null} otherwise.
      * @see Path#matches(String)
      */
@@ -166,6 +166,7 @@ public class PathSet implements Iterable
 
     /**
      * Create a unmodifiable set of strings
+     * @return A set of strings
      */
     public Set<String> toStringSet() {
         final Set<String> set = new HashSet<String>();
@@ -177,6 +178,7 @@ public class PathSet implements Iterable
 
     /**
      * Return an unmodifiable iterator for the paths.
+     * @return An iterator for the paths
      */
     @Override
     public Iterator<Path> iterator() {

Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/api/scripting/SlingBindings.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/scripting/SlingBindings.java?rev=1751432&r1=1751431&r2=1751432&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/api/scripting/SlingBindings.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/api/scripting/SlingBindings.java Tue Jul  5 10:07:10 2016
@@ -163,6 +163,8 @@ public class SlingBindings extends HashM
 
     /**
      * Helper method to get an object with a given type from this map.
+     * @param key The key for the object
+     * @param <ObjectType> The object type
      * @return The searched object if it has the specified type, otherwise <code>null</code> is returned.
      */
     @SuppressWarnings("unchecked")
@@ -176,6 +178,8 @@ public class SlingBindings extends HashM
 
     /**
      * Helper method which invokes {@link #put(Object, Object)} only if the value is not null.
+     * @param key The key of the object
+     * @param value The value
      */
     protected void safePut(final String key, final Object value) {
         if ( value != null ) {
@@ -185,6 +189,7 @@ public class SlingBindings extends HashM
 
     /**
      * Sets the {@link #FLUSH} property to <code>flush</code>.
+     * @param flush Whether to flush or not
      */
     public void setFlush(boolean flush) {
         put(FLUSH, flush);
@@ -193,6 +198,7 @@ public class SlingBindings extends HashM
     /**
      * Returns the {@link #FLUSH} property if not <code>null</code> and a
      * <code>boolean</code>. Otherwise <code>false</code> is returned.
+     * @return {@code true} if flush
      */
     public boolean getFlush() {
         Boolean value = this.get(FLUSH, Boolean.class);