Lucene - Core
  1. Lucene - Core
  2. LUCENE-926

Document Package level javadocs need improving

    Details

    • Type: Wish Wish
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.2
    • Fix Version/s: 2.2
    • Component/s: general/javadocs
    • Labels:
      None

      Description

      The document package package level javadocs could use some improving, such as:
      1. Info on what a Document is, as well as Field and Fieldable
      2. Examples of FieldSelectors and how to implement
      3. Samples of using DateTools and NumberTools

      1. LUCENE-926.patch
        4 kB
        Grant Ingersoll
      2. LUCENE-926.patch
        2 kB
        Grant Ingersoll

        Activity

        Grant Ingersoll created issue -
        Michael Busch made changes -
        Field Original Value New Value
        Fix Version/s 2.2 [ 12312328 ]
        Grant Ingersoll made changes -
        Assignee Grant Ingersoll [ gsingers ]
        Grant Ingersoll made changes -
        Status Open [ 1 ] In Progress [ 3 ]
        Hide
        Grant Ingersoll added a comment -

        A DRAFT (and I do mean DRAFT) first patch for the Document package level javadocs.

        Show
        Grant Ingersoll added a comment - A DRAFT (and I do mean DRAFT) first patch for the Document package level javadocs.
        Grant Ingersoll made changes -
        Attachment LUCENE-926.patch [ 12359637 ]
        Hide
        Grant Ingersoll added a comment -

        I am going to commit this shortly, b/c I won't have time to tomorrow or before the official release. Please feel free to add a new patch and any additions.

        Show
        Grant Ingersoll added a comment - I am going to commit this shortly, b/c I won't have time to tomorrow or before the official release. Please feel free to add a new patch and any additions.
        Grant Ingersoll made changes -
        Attachment LUCENE-926.patch [ 12359721 ]
        Hide
        Grant Ingersoll added a comment -

        Committed last patch (with one minor change in the link to the demo) to both 2_2 and trunk.

        Show
        Grant Ingersoll added a comment - Committed last patch (with one minor change in the link to the demo) to both 2_2 and trunk.
        Grant Ingersoll made changes -
        Resolution Fixed [ 1 ]
        Status In Progress [ 3 ] Resolved [ 5 ]
        Lucene Fields [New]
        Michael Busch made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        Mark Thomas made changes -
        Workflow jira [ 12405839 ] Default workflow, editable Closed status [ 12562541 ]
        Mark Thomas made changes -
        Workflow Default workflow, editable Closed status [ 12562541 ] jira [ 12583506 ]
        Transition Time In Source Status Execution Times Last Executer Last Execution Date
        Open Open In Progress In Progress
        5d 19h 1m 1 Grant Ingersoll 13/Jun/07 21:37
        In Progress In Progress Resolved Resolved
        15h 6m 1 Grant Ingersoll 14/Jun/07 12:44
        Resolved Resolved Closed Closed
        4d 19h 30m 1 Michael Busch 19/Jun/07 08:14

          People

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

            Dates

            • Created:
              Updated:
              Resolved:

              Development