Merge "Document TreeWalk#min()"

This commit is contained in:
Han-Wen NIenhuys 2022-08-01 13:07:29 -04:00 committed by Gerrit Code Review @ Eclipse.org
commit e030b106c5
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;