Merger: clarify getBaseCommit javadoc

Change-Id: Ic52475248a545d51d3d8ac31a24f0344a1241e45
12 years ago · fa5582f3fe
1 changed files with 6 additions and 2 deletions
--- a/org.eclipse.jgit/src/org/eclipse/jgit/merge/Merger.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/merge/Merger.java
@ -193,11 +193,15 @@ public abstract class Merger {

 	/**
 	 * Return the merge base of two commits.
+	 * <p>
+	 * May only be called after {@link #merge(RevCommit...)}.
 	 *
 	 * @param aIdx
-	 *            index of the first commit in {@link #sourceObjects}.
+	 *            index of the first commit in tips passed to
+	 *            {@link #merge(RevCommit...)}.
 	 * @param bIdx
-	 *            index of the second commit in {@link #sourceObjects}.
+	 *            index of the second commit in tips passed to
+	 *            {@link #merge(RevCommit...)}.
 	 * @return the merge base of two commits
 	 * @throws IncorrectObjectTypeException
 	 *             one of the input objects is not a commit.