[
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-unsubscr...@lucene.apache.org
For additional commands, e-mail: java-dev-h...@lucene.apache.org
