[jira] Updated: (LUCENE-1760) TokenStream API javadoc improvements

["Mark Miller (JIRA)" <ji...@apache.org>]

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

Mark Miller updated LUCENE-1760:
--------------------------------

    Attachment: TokenStreamJavadoc.patch

Okay, here is a rough draft. I'd still like to look over and polish a bit - but I think this covers the broad strokes.

One thing I would like to clear up, but I'm not exactly sure what its saying:

 * {@link TokenStream} now extends {@link AttributeSource}, which provides
 * access to all of the token {@link Attribute}s for the {@link TokenStream}.
 * Note that only one instance per {@link AttributeImpl} is created and reused
 * for every token. This approach reduces object creation and allows local
 * caching of references to the {@link AttributeImpl}s. See
 * {@link #incrementToken()} for further details.

> TokenStream API javadoc improvements
> ------------------------------------
>
>                 Key: LUCENE-1760
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1760
>             Project: Lucene - Java
>          Issue Type: Task
>          Components: Analysis
>            Reporter: Michael Busch
>            Assignee: Mark Miller
>            Priority: Trivial
>             Fix For: 2.9
>
>         Attachments: lucene-1760.patch, TokenStreamJavadoc.patch
>
>
> - Change or remove experimental warnings of new TokenStream API
> - Improve javadocs for deprecated Token constructors
> - javadocs for TeeSinkTokenStream.SinkFilter

-- 
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