[
https://issues.apache.org/jira/browse/OPENNLP-789?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17907091#comment-17907091
]
ASF GitHub Bot commented on OPENNLP-789:
----------------------------------------
rzo1 commented on code in PR #200:
URL: https://github.com/apache/opennlp-sandbox/pull/200#discussion_r1892565760
##########
opennlp-wsd/src/main/java/opennlp/tools/disambiguator/WordPOS.java:
##########
@@ -108,7 +115,13 @@ public List<Synset> getSynsets() {
return Collections.emptyList();
}
- // uses Stemming to check if two words are equivalent
+ /**
+ * Applies stemming to check whether {@code wordToCompare} is equivalent
+ * to the current {@link WordPOS} instance.
+ *
+ * @param wordToCompare The {@link WordPOS} instance to compare against.
+ */
+ // TODO check the performance of the current implementation (!)
Review Comment:
Does this deserve a Jira?
> Extend JavaDoc for WSD component
> --------------------------------
>
> Key: OPENNLP-789
> URL: https://issues.apache.org/jira/browse/OPENNLP-789
> Project: OpenNLP
> Issue Type: Improvement
> Components: wsd
> Reporter: Jörn Kottmann
> Assignee: Martin Wiesner
> Priority: Major
> Labels: wsd
> Fix For: 2.5.2
>
>
> The WSDisambiguator is the main interface for the wsd component. It should
> have much more javadocs explaining what it does and what wsd is.
> Additionally add at least short javadocs to each class and method in the
> disambiguator package. One sentence is the minimum here.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
