You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@opennlp.apache.org by GitBox <gi...@apache.org> on 2023/01/02 11:22:56 UTC

[GitHub] [opennlp] rzo1 commented on a diff in pull request #477: OPENNLP-1431 Enhance JavaDoc in opennlp.tools.dictionary and opennlp.tools.entitylinker packages

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?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@opennlp.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org