[
https://issues.apache.org/jira/browse/OPENNLP-1404?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17643022#comment-17643022
]
ASF GitHub Bot commented on OPENNLP-1404:
-----------------------------------------
mawiesne commented on code in PR #446:
URL: https://github.com/apache/opennlp/pull/446#discussion_r1038989413
##########
opennlp-tools/src/main/java/opennlp/tools/postag/TagDictionary.java:
##########
@@ -25,11 +25,18 @@
public interface TagDictionary {
/**
- * Returns a list of valid tags for the specified word.
+ * Retrieves a list of valid tags for the specified {@code word}.
*
* @param word The word.
- * @return A list of valid tags for the specified word or null if no
information
- * is available for that word.
+ * @return An array of valid tags for the specified {@code word} or {@code
null} if
+ * no information is available for that word.
*/
String[] getTags(String word);
+
+ /**
+ * Whether if the dictionary is case-sensitive or not.
Review Comment:
Did not spot that one, or misread the sentence in that moment.
> Enhance JavaDoc in opennlp.tools.postag package
> -----------------------------------------------
>
> Key: OPENNLP-1404
> URL: https://issues.apache.org/jira/browse/OPENNLP-1404
> Project: OpenNLP
> Issue Type: Improvement
> Components: Documentation, POS Tagger
> Affects Versions: 2.1.0
> Reporter: Martin Wiesner
> Priority: Minor
> Fix For: 2.1.1
>
>
> The JavaDoc of the _opennlp.tools.postag_ package suffers from several
> inconsistencies and missing descriptions. Moreover, several typos are present
> that need sanitizing.
> It needs enhancements and/or additions to provide more clarity for readers of
> this part of the OpenNLP API.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
