[jira] Created: (LUCENE-1386) Document package javadocs needs improving

["Raanan Mintz (JIRA)" <ji...@apache.org>]

Document package javadocs needs improving
-----------------------------------------

                 Key: LUCENE-1386
                 URL: https://issues.apache.org/jira/browse/LUCENE-1386
             Project: Lucene - Java
          Issue Type: Improvement
          Components: Javadocs
            Reporter: Raanan Mintz
            Priority: Minor


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.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org