Clarify TreeCache.Builder.setMaxDepth() doc.
Project: http://git-wip-us.apache.org/repos/asf/curator/repo Commit: http://git-wip-us.apache.org/repos/asf/curator/commit/b9728251 Tree: http://git-wip-us.apache.org/repos/asf/curator/tree/b9728251 Diff: http://git-wip-us.apache.org/repos/asf/curator/diff/b9728251 Branch: refs/heads/master Commit: b972825171d559c04931f34f92ade1fab42fd479 Parents: d589063 Author: Scott Blum <[email protected]> Authored: Mon Oct 20 15:59:59 2014 -0400 Committer: Scott Blum <[email protected]> Committed: Mon Oct 20 15:59:59 2014 -0400 ---------------------------------------------------------------------- .../org/apache/curator/framework/recipes/cache/TreeCache.java | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/curator/blob/b9728251/curator-recipes/src/main/java/org/apache/curator/framework/recipes/cache/TreeCache.java ---------------------------------------------------------------------- diff --git a/curator-recipes/src/main/java/org/apache/curator/framework/recipes/cache/TreeCache.java b/curator-recipes/src/main/java/org/apache/curator/framework/recipes/cache/TreeCache.java index db6ba01..fbe51df 100644 --- a/curator-recipes/src/main/java/org/apache/curator/framework/recipes/cache/TreeCache.java +++ b/curator-recipes/src/main/java/org/apache/curator/framework/recipes/cache/TreeCache.java @@ -150,8 +150,9 @@ public class TreeCache implements Closeable /** * Sets the maximum depth to explore/watch. A {@code maxDepth} of {@code 0} will watch only - * the root node; a {@code maxDepth} of {@code 1} will watch the root node and its immediate - * children. Default: {@code Integer.MAX_VALUE} + * the root node (like {@link NodeCache}); a {@code maxDepth} of {@code 1} will watch the + * root node and its immediate children (kind of like {@link PathChildrenCache}. + * Default: {@code Integer.MAX_VALUE} */ public Builder setMaxDepth(int maxDepth) {
