You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Michael Busch (JIRA)" <ji...@apache.org> on 2009/07/25 02:13:14 UTC

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

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: Michael Busch
            Priority: Trivial
             Fix For: 2.9


- 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


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

Posted by "Michael McCandless (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-1760?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michael McCandless reopened LUCENE-1760:
----------------------------------------


Reopening so we don't forget Mark's last comment...

> 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: Michael Busch
>            Priority: Trivial
>             Fix For: 2.9
>
>         Attachments: lucene-1760.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


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

Posted by "Michael Busch (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/LUCENE-1760?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12747122#action_12747122 ] 

Michael Busch commented on LUCENE-1760:
---------------------------------------

Thanks for taking this, Mark. Let me know if you need help.

> 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
>            Priority: Trivial
>             Fix For: 2.9
>
>         Attachments: lucene-1760.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


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

Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/LUCENE-1760?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12747415#action_12747415 ] 

Mark Miller commented on LUCENE-1760:
-------------------------------------

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


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

Posted by "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


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

Posted by "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 resolved LUCENE-1760.
---------------------------------

    Resolution: Fixed

I took care of it.

> 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: Michael Busch
>            Priority: Trivial
>             Fix For: 2.9
>
>         Attachments: lucene-1760.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


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

Posted by "Michael Busch (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-1760?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michael Busch resolved LUCENE-1760.
-----------------------------------

    Resolution: Fixed

Committed revision 797714.

> 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: Michael Busch
>            Priority: Trivial
>             Fix For: 2.9
>
>         Attachments: lucene-1760.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


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

Posted by "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 reopened LUCENE-1760:
---------------------------------


Would love to have some sample code, but at a min we have to update javadocs to have full contract (end, close)

and see comment:

{quote}
And close()....
is there a way these could be consolidated?

-Yonik
{quote}

> 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: Michael Busch
>            Priority: Trivial
>             Fix For: 2.9
>
>         Attachments: lucene-1760.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


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

Posted by "Michael Busch (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-1760?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Michael Busch updated LUCENE-1760:
----------------------------------

    Attachment: lucene-1760.patch

- Removes new TokenStream API warnings
- fixes a javadoc reference in analysis/package.html
- adds comments to TeeSinkTokenFilter.SinkFilter
- adds comments to deprecated Token constructors

I'm planning to commit this shortly.

> 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: Michael Busch
>            Priority: Trivial
>             Fix For: 2.9
>
>         Attachments: lucene-1760.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


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

Posted by "Uwe Schindler (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/LUCENE-1760?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12747421#action_12747421 ] 

Uwe Schindler commented on LUCENE-1760:
---------------------------------------

Yes. This setting will be removed, with about half of the whole class :( - what a pity.
It will default to true in 3.0 and one must override the abstract incrementToken() method. next() and next(Token) will be removed, too.

> 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


[jira] Issue Comment Edited: (LUCENE-1760) TokenStream API javadoc improvements

Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
    [ 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


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

Posted by "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 reassigned LUCENE-1760:
-----------------------------------

    Assignee:     (was: Michael Busch)

> 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
>            Priority: Trivial
>             Fix For: 2.9
>
>         Attachments: lucene-1760.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


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

Posted by "Michael Busch (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/LUCENE-1760?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12741648#action_12741648 ] 

Michael Busch commented on LUCENE-1760:
---------------------------------------

Thanks, Mark.

> 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: Michael Busch
>            Priority: Trivial
>             Fix For: 2.9
>
>         Attachments: lucene-1760.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


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

Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/LUCENE-1760?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12747428#action_12747428 ] 

Mark Miller commented on LUCENE-1760:
-------------------------------------

bq. what a pity.

Yes, I put your reflection detection/cache code into Similarity last night - that code is great - really clean, really nice design. But we will zap it soon :)

> 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


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

Posted by "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 reassigned LUCENE-1760:
-----------------------------------

    Assignee: Mark Miller

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


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

Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/LUCENE-1760?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12740165#action_12740165 ] 

Mark Miller commented on LUCENE-1760:
-------------------------------------

tokenstream still says token is deprecated

> 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: Michael Busch
>            Priority: Trivial
>             Fix For: 2.9
>
>         Attachments: lucene-1760.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


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

Posted by "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 resolved LUCENE-1760.
---------------------------------

    Resolution: Fixed

Resolving - I may tweak more, but its got what it needs overall.

> 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


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

Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/LUCENE-1760?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745697#action_12745697 ] 

Mark Miller commented on LUCENE-1760:
-------------------------------------

I also think it couldn't hurt to add some javadoc on AttributeSource hashCode and equals - no subclasses override them that I see (tokenfilter, tokenstream, ...) Thats a somewhat confusing situation that I think merits a comment.

> 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: Michael Busch
>            Priority: Trivial
>             Fix For: 2.9
>
>         Attachments: lucene-1760.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


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

Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/LUCENE-1760?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12746870#action_12746870 ] 

Mark Miller commented on LUCENE-1760:
-------------------------------------

Okay - there is some example code ! Its just analysis package.html - so I guess we can point to that from the TokenStream javadoc.

package.html for analysis is kind of ugly - and at times confusing. After giving an example with the new tokenstream API, there is a section saying, there is also a new API and here is stuff about it - but it was just showing an example with the new API ...

> 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: Michael Busch
>            Priority: Trivial
>             Fix For: 2.9
>
>         Attachments: lucene-1760.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