lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Mark Miller (JIRA)" <j...@apache.org>
Subject [jira] Issue Comment Edited: (LUCENE-1760) TokenStream API javadoc improvements
Date Tue, 25 Aug 2009 14:01:59 GMT

    [ https://issues.apache.org/jira/browse/LUCENE-1760?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12747415#action_12747415
] 

Mark Miller edited comment on LUCENE-1760 at 8/25/09 7:01 AM:
--------------------------------------------------------------

   * @deprecated This setting will be <code>true</code> per default in Lucene
3.0,
   * when {@link #incrementToken} is abstract and must be always implemented.
   */
  public static void setOnlyUseNewAPI(boolean onlyUseNewAPI) {
    TokenStream.onlyUseNewAPI = onlyUseNewAPI;
  }


Won't that setting be removed ? Should I add the remove when api is removed reminder here?
The Javadoc appears a bit misleading.

*edit

I guess my issue is, it appears ambiguous as to what method must be implemented. @depreacted
gives you the hint, but I'm just going to reword to make clear.

      was (Author: markrmiller@gmail.com):
       * @deprecated This setting will be <code>true</code> per default in Lucene
3.0,
   * when {@link #incrementToken} is abstract and must be always implemented.
   */
  public static void setOnlyUseNewAPI(boolean onlyUseNewAPI) {
    TokenStream.onlyUseNewAPI = onlyUseNewAPI;
  }


Won't that setting be removed ? Should I add the remove when api is removed reminder here?
The Javadoc appears a bit misleading.
  
> 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


Mime
View raw message