Lucene - Core
  1. Lucene - Core
  2. LUCENE-765

Index package level javadocs needs content

    Details

    • Type: Wish Wish
    • Status: Open
    • Priority: Minor 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.

        Activity

        Show
        Daniel Naber added a comment - Some of this is already here: http://lucene.apache.org/java/docs/api/overview-summary.html#overview_description
        Hide
        Robert Muir added a comment -

        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.

        Show
        Robert Muir added a comment - 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.

          People

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

            Dates

            • Created:
              Updated:

              Development