[
https://issues.apache.org/jira/browse/OPENNLP-1403?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17642999#comment-17642999
]
ASF GitHub Bot commented on OPENNLP-1403:
-----------------------------------------
mawiesne commented on code in PR #445:
URL: https://github.com/apache/opennlp/pull/445#discussion_r1038968895
##########
opennlp-tools/src/main/java/opennlp/tools/langdetect/DefaultLanguageDetectorContextGenerator.java:
##########
@@ -34,11 +34,12 @@ public class DefaultLanguageDetectorContextGenerator
implements LanguageDetector
protected final CharSequenceNormalizer normalizer;
/**
- * Creates a customizable @{@link DefaultLanguageDetectorContextGenerator}
that computes ngrams from text
- * @param minLength min ngrams chars
- * @param maxLength max ngrams chars
- * @param normalizers zero or more normalizers to
- * be applied in to the text before extracting ngrams
+ * Creates a customizable {@link DefaultLanguageDetectorContextGenerator}
that computes ngrams from text.
+ *
+ * @param minLength The min number of ngrams characters. Must be greater
than {@code 0}.
+ * @param maxLength The max number of ngrams characters. Must be greater
than {@code 0}
+ * and must be greater than {@code minLength}.
+ * @param normalizers zero or more normalizers to be applied in to the text
before extracting ngrams.
Review Comment:
Ya, should have written Z here. Will take note for the next PR (postag
package) and make it pretty there.
> Enhance JavaDoc in opennlp.tools.langdetect and opennlp.tools.languagemodel
> packages
> ------------------------------------------------------------------------------------
>
> Key: OPENNLP-1403
> URL: https://issues.apache.org/jira/browse/OPENNLP-1403
> Project: OpenNLP
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 2.1.0
> Reporter: Martin Wiesner
> Priority: Minor
> Fix For: 2.1.1
>
>
> The JavaDoc of the _opennlp.tools.langdetect_ and
> _opennlp.tools.languagemodel_ packages suffer 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
> that part of the OpenNLP API.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
