docs: update documentation

Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>

jnosql-communication/jnosql-communication-semistructured/src/main/java/module-info.java

@@ -10,14 +10,15 @@
  *  Contributors:
  *  Otavio Santana
  */
-module org.eclipse.jnosql.communication.column {
+/**
+ * This module contains the communication layer to work with semi-structured databases.
+ */
+module org.eclipse.jnosql.communication.semistructured {
     uses org.eclipse.jnosql.communication.semistructured.DatabaseConfiguration;
     requires org.eclipse.jnosql.communication.core;
     requires org.eclipse.jnosql.communication.query;
     requires jakarta.json.bind;
     requires jakarta.json;
     requires jakarta.data;
-
     opens org.eclipse.jnosql.communication.semistructured;
-
 }

jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/CriteriaCondition.java

@@ -156,6 +156,13 @@ public String toString() {
                 '}';
     }
 
+    /**
+     * Creates a new {@link CriteriaCondition} with the same element and condition, but with the read-only flag set to true.
+     *
+     * @param condition the condition to be marked as read-only
+     * @return a new read-only condition
+     * @throws NullPointerException when the condition is null
+     */
     public static CriteriaCondition readOnly(CriteriaCondition condition) {
         Objects.requireNonNull(condition, "Condition is required");
         return new CriteriaCondition(condition.element(), condition.condition(), true);

jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQuery.java

@@ -125,6 +125,9 @@ interface EntityDelete {
     interface DeleteProvider extends Function<String[], EntityDelete>, Supplier<EntityDelete> {
     }
 
+    /**
+     * The initial element in the Column delete query.
+     */
     interface DeleteQueryBuilderProvider extends Function<String[], DeleteQueryBuilder>,
             Supplier<DeleteQueryBuilder> {
 

jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQueryParams.java

@@ -16,6 +16,8 @@
 
 /**
  * The result of {@link DeleteQueryParams} that has {@link DeleteQuery} and {@link Params}.
+ * @param query  the {@link DeleteQuery}
+ * @param params the {@link Params}
  */
 public record DeleteQueryParams(DeleteQuery query, Params params) {
 

jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQueryParser.java

@@ -22,6 +22,10 @@
 
 import static java.util.Objects.requireNonNull;
 
+/**
+ * The {@link DeleteQueryParser} has the logic to convert from {@link org.eclipse.jnosql.communication.query.DeleteQuery}
+ * to {@link DeleteQueryParams}.
+ */
 public final class DeleteQueryParser implements BiFunction<org.eclipse.jnosql.communication.query.DeleteQuery, CommunicationObserverParser, DeleteQueryParams> {
 
 

jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/QueryParams.java

@@ -16,6 +16,8 @@
 
 /**
  * The result of {@link org.eclipse.jnosql.communication.query.SelectQueryConverter} that has {@link SelectQuery} and {@link Params}.
+ * @param query  the {@link SelectQuery}
+ * @param params the {@link Params}
  */
 public record QueryParams(SelectQuery query, Params params) {
 

jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/SelectQueryParser.java

@@ -28,6 +28,9 @@
 public final class SelectQueryParser implements BiFunction<org.eclipse.jnosql.communication.query.SelectQuery, CommunicationObserverParser, QueryParams> {
 
 
+    /**
+     * The default constructor
+     */
     public SelectQueryParser() {
     }