[
https://issues.apache.org/jira/browse/OPENNLP-1410?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17649341#comment-17649341
]
ASF GitHub Bot commented on OPENNLP-1410:
-----------------------------------------
kinow commented on code in PR #456:
URL: https://github.com/apache/opennlp/pull/456#discussion_r1052237129
##########
opennlp-tools/src/main/java/opennlp/tools/namefind/RegexNameFinder.java:
##########
@@ -178,18 +197,34 @@ public void clearAdaptiveData() {
// nothing to clear
}
+ /**
+ * @return Retrieves the {@link Pattern patterns} used.
+ */
+ // TODO Unclear what 'm' stands for: Discuss refactoring, deprecation, or
removal of unused method.
public Pattern[] getmPatterns() {
return mPatterns;
}
+ /**
+ * @param mPatterns The {@link Pattern patterns} to be set.
+ */
+ // TODO Unclear what 'm' stands for: Discuss refactoring, deprecation, or
removal of unused method.
public void setmPatterns(Pattern[] mPatterns) {
this.mPatterns = mPatterns;
}
+ /**
+ * @return Retrieves the type used.
+ */
+ // TODO Unclear what 's' stands for: Discuss refactoring, deprecation, or
removal of unused method.
public String getsType() {
Review Comment:
+1 to A or B (we've made a few binary backward incompatible changes anyway
:shrug: )
##########
opennlp-tools/src/main/java/opennlp/tools/namefind/RegexNameFinder.java:
##########
@@ -178,18 +197,34 @@ public void clearAdaptiveData() {
// nothing to clear
}
+ /**
+ * @return Retrieves the {@link Pattern patterns} used.
+ */
+ // TODO Unclear what 'm' stands for: Discuss refactoring, deprecation, or
removal of unused method.
public Pattern[] getmPatterns() {
return mPatterns;
}
+ /**
+ * @param mPatterns The {@link Pattern patterns} to be set.
+ */
+ // TODO Unclear what 'm' stands for: Discuss refactoring, deprecation, or
removal of unused method.
public void setmPatterns(Pattern[] mPatterns) {
this.mPatterns = mPatterns;
}
+ /**
+ * @return Retrieves the type used.
+ */
+ // TODO Unclear what 's' stands for: Discuss refactoring, deprecation, or
removal of unused method.
public String getsType() {
Review Comment:
+1 to A or B (we've made a few binary backward incompatible changes anyway )
> Enhance JavaDoc in opennlp.tools.namefind package
> -------------------------------------------------
>
> Key: OPENNLP-1410
> URL: https://issues.apache.org/jira/browse/OPENNLP-1410
> Project: OpenNLP
> Issue Type: Improvement
> Components: Name Finder
> Affects Versions: 2.1.0
> Reporter: Martin Wiesner
> Assignee: Martin Wiesner
> Priority: Minor
> Fix For: 2.1.1
>
>
> The JavaDoc the _opennlp.tools.namefind_ 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.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
