[LUCENE-250] Javadocs for Scorer.java and TermScorer.java

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Component/s: core/search

Environment

Operating System: other
Platform: Other

• Bugzilla Id: 30360
• Assignee: Lucene Developers
• Reporter: Paul Elschot
• Created: 28/Jul/04 17:06
• Updated: 28/Aug/22 11:17
• Resolved: 27/May/06 01:38

Description

Javadocs for Scorer.java and TermScorer.java
Also changed build.xml to use package access for the
javadocs target. That caused some minor error javadoc messages
in CompoundFileReader.java and FieldInfos.java, which are also fixed.

The patch posted earlier for Weight.java
(a broken javadoc link) is also included.

The attached patch is for all 5 files against the CVS top directory
of 28 July 2004. The only dependency is that package access
is needed for TermScorer.java.

This might be changed by declaring TermScorer as a public class,
but I preferred to use javadoc package access in build.xml
over changing java code.

Using package access for javadocs shows some more undocumented
classes, eg. in the doc page of the search package. This might
encourage folks to write more javadocs...

Regards,
Paul