[jira] [Comment Edited] (OPENNLP-829) Cleanup Doccat package (API and javadoc)

["Tommaso Teofili (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/OPENNLP-829?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15104952#comment-15104952 ] 

Tommaso Teofili edited comment on OPENNLP-829 at 1/18/16 8:47 AM:
------------------------------------------------------------------

I've added and tweaked other javadocs in r 1725190.

I'd like to discuss whether we should change {{DocumentCategorizerME}} javadoc. It currently reads:
{noformat}
Maxent implementation of {@link DocumentCategorizer}.
{noformat}
however with OPENNLP-777 it can also be used to create a naive bayes categorizer (by supplying specific parameters) and thus the above javadoc doesn't sound correct anymore. Suggestions?


was (Author: teofili):
I've added and tweaked other javadocs in r 1725190.

I'd like to discuss whether we should change {{DocumentCategorizerME}} javadoc. It currently reads:
{noformat}
Maxent implementation of {@link DocumentCategorizer}.
{noformat}
however with OPENNLP-777 it can also be used to create a naive bayes categorizer and thus the above javadoc doesn't sound correct anymore. Suggestions?

> Cleanup Doccat package (API and javadoc)
> ----------------------------------------
>
>                 Key: OPENNLP-829
>                 URL: https://issues.apache.org/jira/browse/OPENNLP-829
>             Project: OpenNLP
>          Issue Type: Improvement
>          Components: Doccat
>            Reporter: Tommaso Teofili
>            Assignee: Tommaso Teofili
>             Fix For: 1.6.1
>
>
> Doccat package has a bunch of undocumented methods and classes, also some methods are never used and therefore it may make sense to eventually prune them.
> Missing javadoc for classes and public methods should be added.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)