[
https://issues.apache.org/jira/browse/LUCENE-765?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13440484#comment-13440484
]
Robert Muir commented on LUCENE-765:
------------------------------------
I added a start to this for 4.0 with some basic explanations of postings APIs
and index statistics.
It would be great to add more.
> Index package level javadocs needs content
> ------------------------------------------
>
> Key: LUCENE-765
> URL: https://issues.apache.org/jira/browse/LUCENE-765
> Project: Lucene - Core
> Issue Type: Wish
> Components: general/javadocs
> Reporter: Grant Ingersoll
> Priority: Minor
> Labels: newdev
>
> 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, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.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]
