[LUCENE-1386] Document package javadocs needs improving

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Component/s: general/javadocs
• Labels: newdev
• Lucene Fields: New
• Assignee: Unassigned
• Reporter: Raanan Mintz
• Created: 13/Sep/08 22:44
• Updated: 28/Aug/22 11:52

Description

1. Package.html is reasonable satisfactory. The Document class has moderately satisfactory comments.

2. The 6 Field related classes are largely missing class-level comments.

3. The 4 FieldSelect classes are largely missing class-level comments.

4. The 4 tools classes have moderately satisfactory comments, except for the DateTools.Resolution class.

Most of the classes are missing @see references and @since information. Some terminology and concepts need definition, such as "normalization factors" and "term vector". Method-level comments are generally satisfactory, but somewhat repetitive between classes and interfaces. An interface/abstract method should be explained once only, not repeated in each sub-class.