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

Index package level javadocs needs content

    XMLWordPrintableJSON

Details

    • Wish
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • None
    • 7.5, 8.0
    • general/javadocs
    • 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

        1. LUCENE-765.patch
          19 kB
          Michael Sokolov
        2. LUCENE-765.patch
          19 kB
          Michael Sokolov
        3. LUCENE-765.patch
          20 kB
          Michael Sokolov
        4. LUCENE-765.patch
          18 kB
          Michael Sokolov
        5. LUCENE-765.patch
          18 kB
          Michael Sokolov

        Activity

          People

            Unassigned Unassigned
            gsingers Grant Ingersoll
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: