From 8a3a6a99af4dace046324dae2bc648d5aec0ee19 Mon Sep 17 00:00:00 2001 From: Han-Wen Nienhuys Date: Mon, 1 Aug 2022 15:39:07 +0200 Subject: [PATCH] Document TreeWalk#min() Change-Id: I29a6c023929d8270a8cdd1e7f012817a06428f42 Signed-off-by: Han-Wen Nienhuys --- .../src/org/eclipse/jgit/treewalk/TreeWalk.java | 8 ++++++++ 1 file changed, 8 insertions(+) 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 8269666d26..ece945232e 100644 --- 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; -- 2.39.5