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
This commit is contained in:
Jeff Schumacher 2010-07-12 10:37:10 -07:00
parent 9a48de86d8
commit a20e6f6fec
1 changed files with 3 additions and 1 deletions

View File

@ -146,7 +146,9 @@ public int getRenameScore() {
* 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)