SLING-5821 : Fix javadoc errors and warnings (WiP)
git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1751432 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/sling/api/resource/path/PathSet.java b/src/main/java/org/apache/sling/api/resource/path/PathSet.java
index 2feeaa5..591e543 100644
--- a/src/main/java/org/apache/sling/api/resource/path/PathSet.java
+++ b/src/main/java/org/apache/sling/api/resource/path/PathSet.java
@@ -125,7 +125,7 @@
/**
* 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 @@
/**
* 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 @@
/**
* Return an unmodifiable iterator for the paths.
+ * @return An iterator for the paths
*/
@Override
public Iterator<Path> iterator() {
diff --git a/src/main/java/org/apache/sling/api/scripting/SlingBindings.java b/src/main/java/org/apache/sling/api/scripting/SlingBindings.java
index 17c76cd..042dab6 100644
--- a/src/main/java/org/apache/sling/api/scripting/SlingBindings.java
+++ b/src/main/java/org/apache/sling/api/scripting/SlingBindings.java
@@ -163,6 +163,8 @@
/**
* 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 @@
/**
* 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 @@
/**
* 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 @@
/**
* 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);
