Uploaded image for project: 'Lucene - Core'
  1. Lucene - Core
  2. LUCENE-765

Index package level javadocs needs content

    Details

    • Type: Wish
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: general/javadocs
    • Labels:
    • Lucene Fields:
      New

      Description

      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.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              gsingers Grant Ingersoll
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated: