Document TreeWalk#min()

Change-Id: I29a6c023929d8270a8cdd1e7f012817a06428f42
Signed-off-by: Han-Wen Nienhuys <hanwen@google.com>

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/TreeWalk.java b/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/TreeWalk.java
index 8269666d26e7dae1cdd584371e5ef27eb0416602..ece945232ec8c8755ff4e7107b176928db21eb31 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/TreeWalk.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/TreeWalk.java
@@ -1375,6 +1375,14 @@ public class TreeWalk implements AutoCloseable, AttributesProvider {
                System.arraycopy(tmp, 0, trees, 0, trees.length);
        }
 
+       /**
+        * Returns an AbstractTreeIterator from {@code trees} with the smallest name, and sets its
+        * {@code matches} field. This may clobber {@code matches} in other {@code tree}s. Other iterators
+        * at the same name will have their {@code matches} pointing to the same {@code min()} value.
+        *
+        * @return the smallest tree iterator available.
+        * @throws CorruptObjectException
+        */
        @SuppressWarnings("unused")
        AbstractTreeIterator min() throws CorruptObjectException {
                int i = 0;