docs: update documentation at javadoc

Signed-off-by: Otavio Santana <[email protected]>

Author: otaviojava

jnosql-neo4j/src/main/java/org/eclipse/jnosql/databases/neo4j/communication/EdgeCommunicationException.java

@@ -18,12 +18,9 @@
 
 /**
  * Exception thrown when an issue occurs with edge (relationship) operations in Neo4j.
- * <p>
  * This exception is raised in cases where an edge cannot be created or removed
  * due to missing nodes, constraint violations, or other graph-related inconsistencies.
- * </p>
  *
- * <h3>Common Scenarios:</h3>
  * <ul>
  *     <li>Attempting to create an edge where either the source or target entity does not exist.</li>
  *     <li>Removing an edge that is not found in the graph.</li>

jnosql-neo4j/src/main/java/org/eclipse/jnosql/databases/neo4j/communication/Neo4JCommunicationException.java

@@ -20,12 +20,9 @@
 
 /**
  * Exception representing general communication errors when interacting with a Neo4j database.
- * <p>
  * This exception is used as a base for more specific exceptions related to Neo4j operations,
  * such as Cypher syntax errors, transaction failures, or connectivity issues.
- * </p>
  *
- * <h3>Common Causes:</h3>
  * <ul>
  *     <li>Invalid Cypher query syntax.</li>
  *     <li>Transaction failures during read or write operations.</li>

jnosql-neo4j/src/main/java/org/eclipse/jnosql/databases/neo4j/communication/Neo4JDatabaseManager.java

@@ -29,12 +29,11 @@
  * using the APOC library. Implementations of this interface should handle TTL-related methods
  * accordingly—either by integrating APOC's TTL features or throwing {@link UnsupportedOperationException}
  * if TTL is not supported.</p>
- *
- * @apiNote All write operations, including {@code insert} and {@code update}, will be executed within a transaction.
+ * <p>
+ * All write operations, including {@code insert} and {@code update}, will be executed within a transaction.
  * When performing batch inserts using an iterable, the entire operation will be executed as a single transaction
  * to ensure consistency.
  *
- * <h3>Usage Example:</h3>
  * <pre>
  * Neo4JDatabaseManager manager = ...; // Obtain an instance
  * CommunicationEntity entity = CommunicationEntity.of("User");
@@ -43,8 +42,8 @@
  *
  * manager.insert(entity); // Insert into Neo4j
  * </pre>
- *
- * @apiNote Ensure proper transaction and session management when implementing this interface.
+ * <p>
+ * Ensure proper transaction and session management when implementing this interface.
  * Unsupported TTL operations should result in an {@link UnsupportedOperationException}.
  *
  * @see DatabaseManager
@@ -53,25 +52,26 @@ public interface Neo4JDatabaseManager extends DatabaseManager {
 
     /**
      * A specialized {@link DatabaseManager
-
-    /**
+     * <p>
+     * /**
      * Executes a custom Cypher query with parameters and returns a stream of {@link CommunicationEntity}.
+     *
      * @param cypher     the Cypher query to execute.
      * @param parameters the parameters to bind to the query.
      * @return a stream of {@link CommunicationEntity} matching the query result.
-     * @throws NullPointerException  if any of the arguments are {@code null}.
-     * @throws CypherException if there is an issue with the Cypher syntax.
+     * @throws NullPointerException if any of the arguments are {@code null}.
+     * @throws CypherException      if there is an issue with the Cypher syntax.
      */
     Stream<CommunicationEntity> executeQuery(String cypher, Map<String, Object> parameters);
 
     /**
      * Traverses the graph starting from a node and follows the specified relationship type up to a given depth.
      *
-     * @param startNodeId   the ID of the starting node.
-     * @param relationship  the type of relationship to traverse.
-     * @param depth         the traversal depth limit.
+     * @param startNodeId  the ID of the starting node.
+     * @param relationship the type of relationship to traverse.
+     * @param depth        the traversal depth limit.
      * @return a stream of {@link CommunicationEntity} representing related nodes.
-     * @throws NullPointerException      if any of the arguments are {@code null}.
+     * @throws NullPointerException if any of the arguments are {@code null}.
      */
     Stream<CommunicationEntity> traverse(String startNodeId, String relationship, int depth);
 
@@ -82,7 +82,7 @@ public interface Neo4JDatabaseManager extends DatabaseManager {
      * @param target           the target entity.
      * @param relationshipType the type of relationship to create.
      * @throws EdgeCommunicationException if either the source or target entity does not exist in the database.
-     * @throws NullPointerException      if any of the arguments are {@code null}.
+     * @throws NullPointerException       if any of the arguments are {@code null}.
      */
     void edge(CommunicationEntity source, String relationshipType, CommunicationEntity target);
 
@@ -93,7 +93,7 @@ public interface Neo4JDatabaseManager extends DatabaseManager {
      * @param target           the target entity, which must already exist in the database.
      * @param relationshipType the type of relationship to remove.
      * @throws EdgeCommunicationException if either the source or target entity does not exist in the database.
-     * @throws NullPointerException      if any of the arguments are {@code null}.
+     * @throws NullPointerException       if any of the arguments are {@code null}.
      */
     void remove(CommunicationEntity source, String relationshipType, CommunicationEntity target);
 }

jnosql-neo4j/src/main/java/org/eclipse/jnosql/databases/neo4j/communication/Neo4JQueryBuilder.java

@@ -29,10 +29,10 @@
 import java.util.Map;
 import java.util.stream.Collectors;
 public enum Neo4JQueryBuilder {
+
     INSTANCE;
 
     private static final String INTERNAL_ID = "_id";
-    private static final String NEO4J_ID = "elementId(e)";
 
     public String buildQuery(DeleteQuery query, Map<String, Object> parameters) {
         StringBuilder cypher = new StringBuilder("MATCH (e:");

jnosql-neo4j/src/main/java/org/eclipse/jnosql/databases/neo4j/mapping/Cypher.java

@@ -22,26 +22,20 @@
 
 /**
  * Annotation for defining Cypher queries in Neo4J repositories.
- * <p>
  * This annotation allows users to specify a Cypher query directly on repository methods,
  * enabling custom query execution within {@code Neo4JRepository}.
- * </p>
  *
- * <p>
  * Example usage:
  * <pre>
  * {@code
  * @Cypher("MATCH (n:Person) WHERE n.name = $name RETURN n")
  * List<Person> findByName(@Param("name") String name);
  * }
  * </pre>
- * </p>
  *
- * <p>
  * The {@code value} attribute should contain a valid Cypher query. Query parameters
  * can be defined using the {@code $parameterName} syntax, which will be replaced by
  * method parameters annotated with {@code @Param}.
- * </p>
  *
  * @see Neo4JRepository
  */