Document TreeWalk#min()

Change-Id: I29a6c023929d8270a8cdd1e7f012817a06428f42
Signed-off-by: Han-Wen Nienhuys <hanwen@google.com>
This commit is contained in:
Han-Wen Nienhuys 2022-08-01 15:39:07 +02:00
parent 3bec0b56a5
commit 8a3a6a99af
1 changed files with 8 additions and 0 deletions

View File

@ -1375,6 +1375,14 @@ public void enterSubtree() throws MissingObjectException,
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;