lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Uwe Schindler (JIRA)" <j...@apache.org>
Subject [jira] Updated: (LUCENE-1875) Javadoc of TokenStream.end() somehow confusing
Date Sun, 30 Aug 2009 17:07:32 GMT

     [ https://issues.apache.org/jira/browse/LUCENE-1875?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Uwe Schindler updated LUCENE-1875:
----------------------------------

    Attachment: LUCENE-1875.patch

Replaces {@code ...} by javadoc 1.4 compatible <code/>.

Will commit soon.

> Javadoc of TokenStream.end() somehow confusing
> ----------------------------------------------
>
>                 Key: LUCENE-1875
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1875
>             Project: Lucene - Java
>          Issue Type: Bug
>          Components: Analysis
>    Affects Versions: 2.9
>            Reporter: Uwe Schindler
>            Assignee: Uwe Schindler
>             Fix For: 2.9
>
>         Attachments: LUCENE-1875.patch, LUCENE-1875.patch
>
>
> 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.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Mime
View raw message