[LUCENE-1900] Confusing Javadoc in Searchable.java

• Type: Bug
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 2.9
• Fix Version/s: 2.9
• Component/s: core/search
• Lucene Fields: New, Patch Available
• Assignee: Mark Miller
• Reporter: Nadav Har'El
• Created: 08/Sep/09 15:07
• Updated: 28/Aug/22 12:09
• Resolved: 09/Sep/09 13:53

Description

In Searchable.java, the javadoc for maxdoc() is:

/** Expert: Returns one greater than the largest possible document number.

• Called by search code to compute term weights.
• @see org.apache.lucene.index.IndexReader#maxDoc()

The qualification "expert" and the statement "called by search code to compute term weights" is a bit confusing, It implies that maxdoc() somehow computes weights, which is obviously not true (what it does is explained in the other sentence). Maybe it is used as one factor of the weight, but do we really need to mention this here?