You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Robert Muir (JIRA)" <ji...@apache.org> on 2009/06/29 16:03:47 UTC
[jira] Created: (LUCENE-1722) SmartChineseAnalyzer javadoc
improvement
SmartChineseAnalyzer javadoc improvement
----------------------------------------
Key: LUCENE-1722
URL: https://issues.apache.org/jira/browse/LUCENE-1722
Project: Lucene - Java
Issue Type: Improvement
Components: contrib/analyzers
Reporter: Robert Muir
Priority: Minor
Chinese -> English, and corrections to match reality (removes several javadoc warnings)
--
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-1722) SmartChineseAnalyzer javadoc
improvement
Posted by "Simon Willnauer (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1722?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Simon Willnauer resolved LUCENE-1722.
-------------------------------------
Resolution: Fixed
Fix Version/s: 2.9
Just committed this javadoc improvment - thanks robert!
> SmartChineseAnalyzer javadoc improvement
> ----------------------------------------
>
> Key: LUCENE-1722
> URL: https://issues.apache.org/jira/browse/LUCENE-1722
> Project: Lucene - Java
> Issue Type: Improvement
> Components: contrib/analyzers
> Reporter: Robert Muir
> Assignee: Simon Willnauer
> Priority: Minor
> Fix For: 2.9
>
> Attachments: LUCENE-1722.txt
>
>
> Chinese -> English, and corrections to match reality (removes several javadoc warnings)
--
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-1722) SmartChineseAnalyzer javadoc
improvement
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1722?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12725737#action_12725737 ]
Robert Muir commented on LUCENE-1722:
-------------------------------------
Simon you are right, I only did the public scope javadoc (and some of the comments). I thought this was most important for now, since it would be what the users see.
you are correct there are some package/private/protected javadocs that i didn't get to.
there are also main methods, commented out test code as you mentioned.
finally, basically all the classes are in public scope, and many internal-only classes should instead be package protected (imho). This might involve reorganizing the files a bit.
Let me know if you want me to do these things as well.
Thanks
> SmartChineseAnalyzer javadoc improvement
> ----------------------------------------
>
> Key: LUCENE-1722
> URL: https://issues.apache.org/jira/browse/LUCENE-1722
> Project: Lucene - Java
> Issue Type: Improvement
> Components: contrib/analyzers
> Reporter: Robert Muir
> Assignee: Simon Willnauer
> Priority: Minor
> Attachments: LUCENE-1722.txt
>
>
> Chinese -> English, and corrections to match reality (removes several javadoc warnings)
--
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-1722) SmartChineseAnalyzer javadoc
improvement
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1722?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Robert Muir updated LUCENE-1722:
--------------------------------
Attachment: LUCENE-1722.txt
patch file
> SmartChineseAnalyzer javadoc improvement
> ----------------------------------------
>
> Key: LUCENE-1722
> URL: https://issues.apache.org/jira/browse/LUCENE-1722
> Project: Lucene - Java
> Issue Type: Improvement
> Components: contrib/analyzers
> Reporter: Robert Muir
> Priority: Minor
> Attachments: LUCENE-1722.txt
>
>
> Chinese -> English, and corrections to match reality (removes several javadoc warnings)
--
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-1722) SmartChineseAnalyzer javadoc
improvement
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1722?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12725778#action_12725778 ]
Robert Muir commented on LUCENE-1722:
-------------------------------------
Simon, I believe fixing the scope issues would reduce the documentation work considerably. For many of the classes that really should not be public, there is still a lot of missing documentation.
In my opinion, things such as Utility class and everything in .hhmm package should be package-protected. I already wasted time partially javadocing these things, which probably wasn't a complete waste, but you get the idea.
if you look it over, I think you can see I put much more effort into the main analyzer/tokenizer classes that should be public. So these docs are of higher-quality because I think both users and lucene developers will need to interact with these (such as porting to the new Token api, etc).
I think in the short term, I like this patch as is because I think developers will be able to port it to the new API and users will be able to understand what it does.
I can come back around later and do a more thorough job, but this isn't the only analyzer that needs some documentation improvements!
> SmartChineseAnalyzer javadoc improvement
> ----------------------------------------
>
> Key: LUCENE-1722
> URL: https://issues.apache.org/jira/browse/LUCENE-1722
> Project: Lucene - Java
> Issue Type: Improvement
> Components: contrib/analyzers
> Reporter: Robert Muir
> Assignee: Simon Willnauer
> Priority: Minor
> Attachments: LUCENE-1722.txt
>
>
> Chinese -> English, and corrections to match reality (removes several javadoc warnings)
--
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-1722) SmartChineseAnalyzer javadoc
improvement
Posted by "Simon Willnauer (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1722?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12725771#action_12725771 ]
Simon Willnauer commented on LUCENE-1722:
-----------------------------------------
bq. I thought this was most important for now, since it would be what the users see.
I agree, those are most important. I really appreciate this doc work, again thanks for that. I would like to have this in for 2.9 preferably with all chinese documentation replaced. Would be greate if you could do it!
bq. all the classes are in public scope, and many internal-only classes should instead be package protected (imho). This might involve reorganizing the files a bit.
agreement again. I would rather do that in a second patch / issue as soon as this one is commited. Would this remove some of the addtional documentation work? If so you can leave those as they are.
simon
> SmartChineseAnalyzer javadoc improvement
> ----------------------------------------
>
> Key: LUCENE-1722
> URL: https://issues.apache.org/jira/browse/LUCENE-1722
> Project: Lucene - Java
> Issue Type: Improvement
> Components: contrib/analyzers
> Reporter: Robert Muir
> Assignee: Simon Willnauer
> Priority: Minor
> Attachments: LUCENE-1722.txt
>
>
> Chinese -> English, and corrections to match reality (removes several javadoc warnings)
--
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-1722) SmartChineseAnalyzer javadoc
improvement
Posted by "Simon Willnauer (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1722?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Simon Willnauer reassigned LUCENE-1722:
---------------------------------------
Assignee: Simon Willnauer
> SmartChineseAnalyzer javadoc improvement
> ----------------------------------------
>
> Key: LUCENE-1722
> URL: https://issues.apache.org/jira/browse/LUCENE-1722
> Project: Lucene - Java
> Issue Type: Improvement
> Components: contrib/analyzers
> Reporter: Robert Muir
> Assignee: Simon Willnauer
> Priority: Minor
> Attachments: LUCENE-1722.txt
>
>
> Chinese -> English, and corrections to match reality (removes several javadoc warnings)
--
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-1722) SmartChineseAnalyzer javadoc
improvement
Posted by "Simon Willnauer (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1722?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12725985#action_12725985 ]
Simon Willnauer commented on LUCENE-1722:
-----------------------------------------
bq. In my opinion, things such as Utility class and everything in .hhmm package should be package-protected. I already wasted time partially javadocing these things, which probably wasn't a complete waste, but you get the idea.
Yeah those could be cleaned up quite a bit. Lets do this in a different patch / issue after this one is commited.
bq. I think in the short term, I like this patch as is because I think developers will be able to port it to the new API and users will be able to understand what it does.
Lets get it in, it is a huge improvement to the Chinese documentation and needed too.
bq. I can come back around later and do a more thorough job, but this isn't the only analyzer that needs some documentation improvements!
Thanks for the attitude!
simon
> SmartChineseAnalyzer javadoc improvement
> ----------------------------------------
>
> Key: LUCENE-1722
> URL: https://issues.apache.org/jira/browse/LUCENE-1722
> Project: Lucene - Java
> Issue Type: Improvement
> Components: contrib/analyzers
> Reporter: Robert Muir
> Assignee: Simon Willnauer
> Priority: Minor
> Attachments: LUCENE-1722.txt
>
>
> Chinese -> English, and corrections to match reality (removes several javadoc warnings)
--
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-1722) SmartChineseAnalyzer javadoc
improvement
Posted by "Simon Willnauer (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1722?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12725657#action_12725657 ]
Simon Willnauer commented on LUCENE-1722:
-----------------------------------------
Robert, I had a look at this patch - good work!
Are you planing to add more javadoc fixes to it, I found a couple of inline comment being still chinese in
BigramDictionary.java
BiSegGraph.java
HHMMSegmenter.java
and real javadoc in
WordDictionary.java
I also think we could remove the commented source code in
SegToken.java
SegTokenPair.java
as well as the logger code in
WordDictionary.java
simon
> SmartChineseAnalyzer javadoc improvement
> ----------------------------------------
>
> Key: LUCENE-1722
> URL: https://issues.apache.org/jira/browse/LUCENE-1722
> Project: Lucene - Java
> Issue Type: Improvement
> Components: contrib/analyzers
> Reporter: Robert Muir
> Assignee: Simon Willnauer
> Priority: Minor
> Attachments: LUCENE-1722.txt
>
>
> Chinese -> English, and corrections to match reality (removes several javadoc warnings)
--
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-1722) SmartChineseAnalyzer javadoc
improvement
Posted by "Simon Willnauer (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1722?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12726146#action_12726146 ]
Simon Willnauer commented on LUCENE-1722:
-----------------------------------------
bq. It was mentioned on the mailing list that perhaps this analyzer might be moved in the future (since the datafiles cause analyzers.jar to be very large).
I created a new issue for this - [LUCENE-1728|https://issues.apache.org/jira/browse/LUCENE-1728] feel free to grab it.
simon
> SmartChineseAnalyzer javadoc improvement
> ----------------------------------------
>
> Key: LUCENE-1722
> URL: https://issues.apache.org/jira/browse/LUCENE-1722
> Project: Lucene - Java
> Issue Type: Improvement
> Components: contrib/analyzers
> Reporter: Robert Muir
> Assignee: Simon Willnauer
> Priority: Minor
> Fix For: 2.9
>
> Attachments: LUCENE-1722.txt
>
>
> Chinese -> English, and corrections to match reality (removes several javadoc warnings)
--
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-1722) SmartChineseAnalyzer javadoc
improvement
Posted by "Simon Willnauer (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1722?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12725658#action_12725658 ]
Simon Willnauer commented on LUCENE-1722:
-----------------------------------------
btw. do you speak chinese?!
> SmartChineseAnalyzer javadoc improvement
> ----------------------------------------
>
> Key: LUCENE-1722
> URL: https://issues.apache.org/jira/browse/LUCENE-1722
> Project: Lucene - Java
> Issue Type: Improvement
> Components: contrib/analyzers
> Reporter: Robert Muir
> Assignee: Simon Willnauer
> Priority: Minor
> Attachments: LUCENE-1722.txt
>
>
> Chinese -> English, and corrections to match reality (removes several javadoc warnings)
--
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-1722) SmartChineseAnalyzer javadoc
improvement
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1722?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12726053#action_12726053 ]
Robert Muir commented on LUCENE-1722:
-------------------------------------
Simon, thanks. It was mentioned on the mailing list that perhaps this analyzer might be moved in the future (since the datafiles cause analyzers.jar to be very large).
So, maybe at the same time when/if this is done the files could be reorganized in a way that allows a lot of these internal classes to be marked package private.
> SmartChineseAnalyzer javadoc improvement
> ----------------------------------------
>
> Key: LUCENE-1722
> URL: https://issues.apache.org/jira/browse/LUCENE-1722
> Project: Lucene - Java
> Issue Type: Improvement
> Components: contrib/analyzers
> Reporter: Robert Muir
> Assignee: Simon Willnauer
> Priority: Minor
> Fix For: 2.9
>
> Attachments: LUCENE-1722.txt
>
>
> Chinese -> English, and corrections to match reality (removes several javadoc warnings)
--
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