refactored javadoc limitations for proper html rendering

Author: rashtao

src/main/java/com/arangodb/ArangoCollection.java

@@ -80,81 +80,81 @@ public interface ArangoCollection extends ArangoSerializationAccessor {
      * Creates new documents from the given documents, unless there is already a document with the _key given. If no
      * _key is given, a new unique _key is generated automatically.
      *
+     * Limitations:
+     * - the fields having {@code null} value are always removed during serialization
+     *
      * @param values A List of documents (POJO, VPackSlice or String for JSON)
      * @return information about the documents
      * @throws ArangoDBException
      * @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#create-document">API
      * Documentation</a>
-     *
-     * @implNote The current implementation has the following limitations:
-     * - the fields having {@code null} value are always removed during serialization
      */
     <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(Collection<T> values) throws ArangoDBException;
 
     /**
      * Creates new documents from the given documents, unless there is already a document with the _key given. If no
      * _key is given, a new unique _key is generated automatically.
      *
+     * Limitations:
+     * - the fields having {@code null} value are always removed during serialization
+     *
      * @param values  A List of documents (POJO, VPackSlice or String for JSON)
      * @param options Additional options, can be null
      * @return information about the documents
      * @throws ArangoDBException
      * @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#create-document">API
      * Documentation</a>
-     *
-     * @implNote The current implementation has the following limitations:
-     * - the fields having {@code null} value are always removed during serialization
      */
     <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(
             Collection<T> values, DocumentCreateOptions options) throws ArangoDBException;
 
     /**
      * Bulk imports the given values into the collection.
      *
+     * Limitations:
+     * - the fields having {@code null} value are always removed during serialization
+     *
      * @param values a list of Objects that will be stored as documents
      * @return information about the import
      * @throws ArangoDBException
-     *
-     * @implNote The current implementation has the following limitations:
-     * - the fields having {@code null} value are always removed during serialization
      */
     DocumentImportEntity importDocuments(Collection<?> values) throws ArangoDBException;
 
     /**
      * Bulk imports the given values into the collection.
      *
+     * Limitations:
+     * - the fields having {@code null} value are always removed during serialization
+     *
      * @param values  a list of Objects that will be stored as documents
      * @param options Additional options, can be null
      * @return information about the import
      * @throws ArangoDBException
-     *
-     * @implNote The current implementation has the following limitations:
-     * - the fields having {@code null} value are always removed during serialization
      */
     DocumentImportEntity importDocuments(Collection<?> values, DocumentImportOptions options) throws ArangoDBException;
 
     /**
      * Bulk imports the given values into the collection.
      *
+     * Limitations:
+     * - the fields having {@code null} value are always removed during serialization
+     *
      * @param values JSON-encoded array of objects that will be stored as documents
      * @return information about the import
      * @throws ArangoDBException
-     *
-     * @implNote The current implementation has the following limitations:
-     * - the fields having {@code null} value are always removed during serialization
      */
     DocumentImportEntity importDocuments(String values) throws ArangoDBException;
 
     /**
      * Bulk imports the given values into the collection.
      *
+     * Limitations:
+     * - the fields having {@code null} value are always removed during serialization
+     *
      * @param values  JSON-encoded array of objects that will be stored as documents
      * @param options Additional options, can be null
      * @return information about the import
      * @throws ArangoDBException
-     *
-     * @implNote The current implementation has the following limitations:
-     * - the fields having {@code null} value are always removed during serialization
      */
     DocumentImportEntity importDocuments(String values, DocumentImportOptions options) throws ArangoDBException;
 
@@ -237,30 +237,30 @@ <T> DocumentUpdateEntity<T> replaceDocument(String key, T value, DocumentReplace
      * Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are
      * specified by the _key attributes in the documents in values.
      *
+     * Limitations:
+     * - the fields having {@code null} value are always removed during serialization
+     *
      * @param values A List of documents (POJO, VPackSlice or String for JSON)
      * @return information about the documents
      * @throws ArangoDBException
      * @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#replace-documents">API
      * Documentation</a>
-     *
-     * @implNote The current implementation has the following limitations:
-     * - the fields having {@code null} value are always removed during serialization
      */
     <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(Collection<T> values) throws ArangoDBException;
 
     /**
      * Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are
      * specified by the _key attributes in the documents in values.
      *
+     * Limitations:
+     * - the fields having {@code null} value are always removed during serialization
+     *
      * @param values  A List of documents (POJO, VPackSlice or String for JSON)
      * @param options Additional options, can be null
      * @return information about the documents
      * @throws ArangoDBException
      * @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#replace-documents">API
      * Documentation</a>
-     *
-     * @implNote The current implementation has the following limitations:
-     * - the fields having {@code null} value are always removed during serialization
      */
     <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(
             Collection<T> values, DocumentReplaceOptions options) throws ArangoDBException;

src/main/java/com/arangodb/model/DocumentCreateOptions.java

@@ -104,16 +104,16 @@ public OverwriteMode getOverwriteMode() {
     }
 
     /**
+     * Limitations:
+     * - {@code keepNull} parameter is not supported
+     * - the fields having {@code null} value are always removed during serialization
+     * Therefore in case of {@link OverwriteMode#update}, existing attributes cannot be removed.
+     *
      * @param overwriteMode This parameter can be set to replace or update. If given it sets implicitly the overwrite
      *                      flag. In case it is set to update, the replace-insert becomes an update-insert. Otherwise
      *                      this option follows the rules of the overwrite parameter.
      * @return options
      * @since ArangoDB 3.7
-     *
-     * @implNote The current implementation has the following limitations:
-     * - `keepNull` parameter is not supported
-     * - the fields having {@code null} value are always removed during serialization
-     * Therefore in case of {@link OverwriteMode#update}, existing attributes cannot be removed.
      */
     public DocumentCreateOptions overwriteMode(final OverwriteMode overwriteMode) {
         this.overwriteMode = overwriteMode;
@@ -153,13 +153,13 @@ public Boolean getMergeObjects() {
     }
 
     /**
+     * Only considered if {@link this#overwriteMode} is set to {@link OverwriteMode#update}
+     *
      * @param mergeObjects Controls whether objects (not arrays) will be merged if present in both the existing and the patch
      *                     document. If set to false, the value in the patch document will overwrite the existing document's
      *                     value. If set to true, objects will be merged. The default is true.
      * @return options
      * @since ArangoDB 3.7
-     *
-     * @apiNote only considered if {@link this#overwriteMode} is set to {@link OverwriteMode#update}
      */
     public DocumentCreateOptions mergeObjects(Boolean mergeObjects) {
         this.mergeObjects = mergeObjects;