[
https://issues.apache.org/jira/browse/OPENNLP-1422?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17651992#comment-17651992
]
ASF GitHub Bot commented on OPENNLP-1422:
-----------------------------------------
mawiesne commented on code in PR #468:
URL: https://github.com/apache/opennlp/pull/468#discussion_r1057180967
##########
opennlp-tools/src/main/java/opennlp/tools/formats/BioNLP2004NameSampleStream.java:
##########
@@ -32,15 +32,25 @@
import opennlp.tools.util.StringUtil;
/**
- * Parser for the training files of the BioNLP/NLPBA 2004 shared task.
+ * A {@link ObjectStream sample stream} for the training files of the
+ * BioNLP/NLPBA 2004 shared task.
* <p>
- * The data contains five named entity types: DNA, RNA, protein, cell_type and
cell_line.<br>
+ * The data contains five named entity types:
+ * <ul>
+ * <li>{@code DNA}</li>
+ * <li>{@code RNA}</li>
+ * <li>{@code protein}</li>
+ * <li>{@code cell_type}</li>
+ * <li>{@code cell_line}</li>
+ * </ul>.
* <p>
- * Data can be found on this web site:<br>
- * http://www-tsujii.is.s.u-tokyo.ac.jp/GENIA/ERtask/report.html
+ * Data can be found on
+ * <a
href="http://www-tsujii.is.s.u-tokyo.ac.jp/GENIA/ERtask/report.html";>this
website</a>
Review Comment:
Resolved in next commit.
> Enhance JavaDoc in opennlp.tools.formats sub-packages
> -----------------------------------------------------
>
> Key: OPENNLP-1422
> URL: https://issues.apache.org/jira/browse/OPENNLP-1422
> Project: OpenNLP
> Issue Type: Improvement
> Components: Formats
> Affects Versions: 2.1.0
> Reporter: Martin Wiesner
> Assignee: Martin Wiesner
> Priority: Minor
> Fix For: 2.1.1
>
>
> The JavaDoc the _opennlp.tools.formats.*_ sub-packages suffer from several
> inconsistencies and missing descriptions. Moreover, several typos are present
> that need sanitizing.
> The classes, interfaces, etc., require enhancements and/or additions to
> provide more clarity for readers.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
