Fixed Misleading Javadoc

The javadoc for the setRenameLimit method in RenameDetector said
that you could only have limits in the range (0,100), implying
that 0 and 100 were illegal inputs. The code, however, allowed 0 and
100. I changed the javadoc to say that the range [0,100] was legal.
I also documented the IllegalArgumentException that is thrown if the
limit is outside that range.

Change-Id: I916838f254859f6f0e1516bb55b8e7dc87e57dc2

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/diff/RenameDetector.java b/org.eclipse.jgit/src/org/eclipse/jgit/diff/RenameDetector.java
index 87a67a79c6b539d41bf382d9bbcb887c3eeabb40..04e669ffe9a7c050df4103184382d090d4839a29 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/diff/RenameDetector.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/diff/RenameDetector.java
@@ -146,7 +146,9 @@ public class RenameDetector {
         * that approximately 60% of the bytes in the files are identical.
         *
         * @param score
-        *            new rename score, must be within (0, 100).
+        *            new rename score, must be within [0, 100].
+        * @throws IllegalArgumentException
+        *             the score was not within [0, 100].
         */
        public void setRenameScore(int score) {
                if (score < 0 || score > 100)