[jira] [Commented] (OPENNLP-1431) Enhance JavaDoc in opennlp.tools.dictionary and opennlp.tools.entitylinker packages

["ASF GitHub Bot (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/OPENNLP-1431?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17653584#comment-17653584 ] 

ASF GitHub Bot commented on OPENNLP-1431:
-----------------------------------------

rzo1 commented on code in PR #477:
URL: https://github.com/apache/opennlp/pull/477#discussion_r1059971597


##########
opennlp-tools/src/main/java/opennlp/tools/dictionary/serializer/Attributes.java:
##########
@@ -24,20 +24,20 @@
 
 /**
  * The {@link Attributes} class stores name value pairs.
- *
- * Problem: The HashMap for storing the name value pairs has a very high
- * memory footprint, replace it.
+ * <p>
+ * Problem: If a {@link HashMap} is used storing name-value pairs this results

Review Comment:
   :-)



##########
opennlp-tools/src/main/java/opennlp/tools/dictionary/serializer/DictionaryEntryPersistor.java:
##########
@@ -230,16 +244,17 @@ public static boolean create(InputStream in, EntryInserter inserter)
 
   /**
    * Serializes the given entries to the given {@link OutputStream}.
-   *
+   * <p>
+   * <b>Note:</b>
    * After the serialization is finished the provided
    * {@link OutputStream} remains open.
    *
-   * @param out stream to serialize to
-   * @param entries entries to serialize
+   * @param out The {@link OutputStream} to serialize to.
+   * @param entries The {@link Entry entries} to serialize.
    *
-   * @throws IOException If an I/O error occurs
-   * @deprecated Use
-   *     {@link DictionaryEntryPersistor#serialize(java.io.OutputStream, java.util.Iterator, boolean)} instead
+   * @throws IOException Thrown if IO errors occurred.
+   * @throws InvalidFormatException Thrown if parameters were invalid.
+   * @deprecated Use {@link DictionaryEntryPersistor#serialize(OutputStream, Iterator, boolean)} instead.

Review Comment:
   Didn't check history but might be a candidate for removal via separate issue? wdyt?





> Enhance JavaDoc in opennlp.tools.dictionary and opennlp.tools.entitylinker packages
> -----------------------------------------------------------------------------------
>
>                 Key: OPENNLP-1431
>                 URL: https://issues.apache.org/jira/browse/OPENNLP-1431
>             Project: OpenNLP
>          Issue Type: Improvement
>          Components: Entity Linker
>    Affects Versions: 2.1.0
>            Reporter: Martin Wiesner
>            Assignee: Martin Wiesner
>            Priority: Minor
>             Fix For: 2.1.1
>
>
> The JavaDoc of the _opennlp.tools.dictionary_ and _opennlp.tools.entitylinker_ 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)