From 7a739958bcd450837dcf6049ce11c0189b0a0272 Mon Sep 17 00:00:00 2001
From: Otavio Santana <otaviopolianasantana@gmail.com>
Date: Sat, 2 Mar 2024 20:17:18 +0000
Subject: [PATCH] feat: update template document documentation

Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
---
 .../document/DocumentTemplateProducer.java    |  3 ++-
 .../query/RepositoryDocumentBean.java         | 11 ++++++++++-
 .../mapping/document/query/package-info.java  | 19 -------------------
 .../document/spi/DocumentExtension.java       |  8 ++++++--
 4 files changed, 18 insertions(+), 23 deletions(-)
 delete mode 100644 jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/query/package-info.java

diff --git a/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/DocumentTemplateProducer.java b/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/DocumentTemplateProducer.java
index b87962f91..8574fa28d 100644
--- a/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/DocumentTemplateProducer.java
+++ b/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/DocumentTemplateProducer.java
@@ -29,7 +29,8 @@
 import java.util.function.Function;
 
 /**
- * The producer of {@link DocumentTemplate}
+ * An {@code ApplicationScoped} producer class responsible for creating instances of {@link DocumentTemplate}.
+ * It implements the {@link Function} interface with {@link DatabaseManager} as input and {@link DocumentTemplate} as output.
  */
 @ApplicationScoped
 public class DocumentTemplateProducer implements Function<DatabaseManager, DocumentTemplate> {
diff --git a/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/query/RepositoryDocumentBean.java b/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/query/RepositoryDocumentBean.java
index cfb659f28..f5b2072dd 100644
--- a/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/query/RepositoryDocumentBean.java
+++ b/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/query/RepositoryDocumentBean.java
@@ -32,8 +32,17 @@
 import java.util.HashSet;
 import java.util.Set;
 
+
 /**
- * Artemis discoveryBean to CDI extension to register Repository
+ * This class serves as a JNoSQL discovery bean for CDI extension, responsible for registering Repository instances.
+ * It extends {@link AbstractBean} and is parameterized with type {@code T} representing the repository type.
+ * <p>
+ * Upon instantiation, it initializes with the provided repository type, provider name, and qualifiers.
+ * The provider name specifies the database provider for the repository.
+ * </p>
+ *
+ * @param <T> the type of the repository
+ * @see AbstractBean
  */
 public class RepositoryDocumentBean<T extends DataRepository<T, ?>> extends AbstractBean<T> {
 
diff --git a/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/query/package-info.java b/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/query/package-info.java
deleted file mode 100644
index 7df3441f6..000000000
--- a/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/query/package-info.java
+++ /dev/null
@@ -1,19 +0,0 @@
-/*
- *  Copyright (c) 2022 Contributors to the Eclipse Foundation
- *   All rights reserved. This program and the accompanying materials
- *   are made available under the terms of the Eclipse Public License v1.0
- *   and Apache License v2.0 which accompanies this distribution.
- *   The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
- *   and the Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php.
- *
- *   You may elect to redistribute this code under either of these licenses.
- *
- *   Contributors:
- *
- *   Otavio Santana
- */
-
-/**
- * This package has the implementation to dynamic query to repositories on document database.
- */
-package org.eclipse.jnosql.mapping.document.query;
\ No newline at end of file
diff --git a/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/spi/DocumentExtension.java b/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/spi/DocumentExtension.java
index 995d34cf3..c175e2e6e 100644
--- a/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/spi/DocumentExtension.java
+++ b/jnosql-mapping/jnosql-mapping-document/src/main/java/org/eclipse/jnosql/mapping/document/spi/DocumentExtension.java
@@ -30,9 +30,13 @@
 import java.util.Set;
 import java.util.logging.Logger;
 
+
 /**
- * Extension to start up the DocumentTemplate and Repository
- * from the {@link org.eclipse.jnosql.mapping.Database} qualifier
+ * This CDI extension, {@code DocumentExtension}, observes the CDI container lifecycle events to perform tasks related to
+ * document-based databases and repository beans.
+ * <p>
+ * Upon initialization, it maintains a set of {@link DatabaseMetadata} instances representing the document databases.
+ * </p>
  */
 public class DocumentExtension implements Extension {