[
https://issues.apache.org/jira/browse/LUCENE-765?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16596529#comment-16596529
]
Mike Sokolov commented on LUCENE-765:
-------------------------------------
Ah, OK sorry about that! I had run "ant javadocs" in the core module, and that
passed OK, just with one warning about future change to html5 format, unrelated
to my patch. I didn't realize there were additional checks in precommit – I'm
running that now.
> 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
> Attachments: LUCENE-765.patch, LUCENE-765.patch, LUCENE-765.patch,
> LUCENE-765.patch
>
>
> 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 was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
