feat: update template document documentation

Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
eclipse · Mar 2, 2024 · 7a73995 · 7a73995
1 parent b70a4b6
commit 7a73995
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 23 deletions.
diff --git a/...-document/src/main/java/org/eclipse/jnosql/mapping/document/DocumentTemplateProducer.java b/...-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/...ument/src/main/java/org/eclipse/jnosql/mapping/document/query/RepositoryDocumentBean.java b/...ument/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/...apping-document/src/main/java/org/eclipse/jnosql/mapping/document/query/package-info.java b/...apping-document/src/main/java/org/eclipse/jnosql/mapping/document/query/package-info.java
diff --git a/...ing-document/src/main/java/org/eclipse/jnosql/mapping/document/spi/DocumentExtension.java b/...ing-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 {