Index package level javadocs needs content
------------------------------------------

                 Key: LUCENE-765
                 URL: https://issues.apache.org/jira/browse/LUCENE-765
             Project: Lucene - Java
          Issue Type: Task
          Components: Javadocs
            Reporter: Grant Ingersoll
            Priority: Minor


The org.apache.lucene.index package level javadocs are sorely lacking.  They 
should be updated to give a summary of the important classes, how indexing 
works, etc.  Maybe give an overview of how the different writers coordinate.  
Links to file formats, information on the posting algorithm, etc. would be 
helpful.

See the search package javadocs as a sample of the kind of info that could go 
here.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: 
https://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to