svn commit: r1744369 - /sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/sling/ResourceTraversor.java

[bd...@apache.org]

Author: bdelacretaz
Date: Wed May 18 09:38:38 2016
New Revision: 1744369

URL: http://svn.apache.org/viewvc?rev=1744369&view=rev
Log:
SLING-5578 - javadocs

Modified:
    sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/sling/ResourceTraversor.java

Modified: sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/sling/ResourceTraversor.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/sling/ResourceTraversor.java?rev=1744369&r1=1744368&r2=1744369&view=diff
==============================================================================
--- sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/sling/ResourceTraversor.java (original)
+++ sling/trunk/bundles/commons/json/src/main/java/org/apache/sling/commons/json/sling/ResourceTraversor.java Wed May 18 09:38:38 2016
@@ -52,6 +52,13 @@ public class ResourceTraversor {
 
     private final Resource startResource;
 
+    /** Create a ResourceTraversor, optionally limiting recursion and total number of resources
+     * @param levels recursion levels limit, -1 means no limit
+     * @param maxResources maximum number of resources to collect, ignored if levels == 1
+     * @param resource the root resource to traverse
+     * @param tidy not used
+     * @throws JSONException
+     */
     public ResourceTraversor(final int levels, final long maxResources, final Resource resource, final boolean tidy)
     throws JSONException {
         this.maxResources = maxResources;