Lucene - Core
  1. Lucene - Core
  2. LUCENE-1875

Javadoc of TokenStream.end() somehow confusing

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.9
    • Fix Version/s: 2.9
    • Component/s: modules/analysis
    • Labels:
      None
    • Lucene Fields:
      New

      Description

      The Javadocs of TokenStream.end() are somehow confusing, because they also refer to the old TokenStream API ("after next() returned null"). But one who implements his TokenStream with the old API cannot make use of the end() feature, as he would not use attributes and so cannot update the end offsets (he could, but then he should rewrite the whole TokenStream). To be conform to the old API, there must be an end(Token) method, which we will not add.

      I would drop the old API from this docs.

      1. LUCENE-1875.patch
        6 kB
        Uwe Schindler
      2. LUCENE-1875.patch
        6 kB
        Uwe Schindler

        Activity

        Hide
        Uwe Schindler added a comment -

        Patxh with changed end() javadocs. This patch also removes the

        {@link TokenStream}

        s inside TokenStream.java (it does not make sense to link to the same doc page itsself).

        Show
        Uwe Schindler added a comment - Patxh with changed end() javadocs. This patch also removes the {@link TokenStream} s inside TokenStream.java (it does not make sense to link to the same doc page itsself).
        Hide
        Uwe Schindler added a comment -

        Replaces

        {@code ...}

        by javadoc 1.4 compatible <code/>.

        Will commit soon.

        Show
        Uwe Schindler added a comment - Replaces {@code ...} by javadoc 1.4 compatible <code/>. Will commit soon.
        Hide
        Uwe Schindler added a comment -

        Committed revision: 809381

        Show
        Uwe Schindler added a comment - Committed revision: 809381

          People

          • Assignee:
            Uwe Schindler
            Reporter:
            Uwe Schindler
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development