From 0807d5fa454ad14dfa05afd4e8383e92e0a17172 Mon Sep 17 00:00:00 2001
From: Francesco <stelk.mc@gmail.com>
Date: Tue, 17 Oct 2023 10:55:05 +0200
Subject: [PATCH] Javadoc

---
 .../dbadmin/external/DbAdminAutoConfiguration.java   |  5 +++++
 .../ailef/dbadmin/external/DbAdminProperties.java    | 12 ++++++++++++
 .../dbadmin/external/annotations/DisableExport.java  |  2 +-
 .../dbadmin/external/dbmapping/DbFieldType.java      |  5 +++++
 .../tech/ailef/dbadmin/external/package-info.java    |  5 ++++-
 5 files changed, 27 insertions(+), 2 deletions(-)

diff --git a/src/main/java/tech/ailef/dbadmin/external/DbAdminAutoConfiguration.java b/src/main/java/tech/ailef/dbadmin/external/DbAdminAutoConfiguration.java
index a84ec4a..92d2170 100644
--- a/src/main/java/tech/ailef/dbadmin/external/DbAdminAutoConfiguration.java
+++ b/src/main/java/tech/ailef/dbadmin/external/DbAdminAutoConfiguration.java
@@ -61,6 +61,11 @@ public class DbAdminAutoConfiguration {
 	@Autowired
 	private DbAdminProperties props;
 
+	/**
+	 * Builds and returns the internal data source.
+	 * 
+	 * @return
+	 */
 	@Bean
 	public DataSource internalDataSource() {
 		DataSourceBuilder<?> dataSourceBuilder = DataSourceBuilder.create();
diff --git a/src/main/java/tech/ailef/dbadmin/external/DbAdminProperties.java b/src/main/java/tech/ailef/dbadmin/external/DbAdminProperties.java
index 7f988af..0ac314c 100644
--- a/src/main/java/tech/ailef/dbadmin/external/DbAdminProperties.java
+++ b/src/main/java/tech/ailef/dbadmin/external/DbAdminProperties.java
@@ -50,6 +50,10 @@ public class DbAdminProperties {
 	 */
 	private boolean testMode = false;
 	
+	/**
+	 * Whether Spring Boot Database Admin is enabled
+	 * @return
+	 */
 	public boolean isEnabled() {
 		return enabled;
 	}
@@ -58,6 +62,10 @@ public class DbAdminProperties {
 		this.enabled = enabled;
 	}
 
+	/**
+	 * Returns the prefix that is prepended to all routes registered by Spring Boot Database Admin.
+	 * @return
+	 */
 	public String getBaseUrl() {
 		return baseUrl;
 	}
@@ -66,6 +74,10 @@ public class DbAdminProperties {
 		this.baseUrl = baseUrl;
 	}
 	
+	/**
+	 * Returns the path of the package that contains your JPA `@Entity` classes to be scanned.
+	 * @return
+	 */
 	public String getModelsPackage() {
 		return modelsPackage;
 	}
diff --git a/src/main/java/tech/ailef/dbadmin/external/annotations/DisableExport.java b/src/main/java/tech/ailef/dbadmin/external/annotations/DisableExport.java
index 0588b2f..eb843cf 100644
--- a/src/main/java/tech/ailef/dbadmin/external/annotations/DisableExport.java
+++ b/src/main/java/tech/ailef/dbadmin/external/annotations/DisableExport.java
@@ -25,7 +25,7 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
- * Disables delete actions on the Entity class.
+ * Disables the export functionality on a specific class.
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
diff --git a/src/main/java/tech/ailef/dbadmin/external/dbmapping/DbFieldType.java b/src/main/java/tech/ailef/dbadmin/external/dbmapping/DbFieldType.java
index f63aaca..e847588 100644
--- a/src/main/java/tech/ailef/dbadmin/external/dbmapping/DbFieldType.java
+++ b/src/main/java/tech/ailef/dbadmin/external/dbmapping/DbFieldType.java
@@ -602,6 +602,11 @@ public enum DbFieldType {
 		return false;
 	}
 	
+	/**
+	 * Returns the corresponding {@linkplain DbFieldType} from a Class object.
+	 * @param klass
+	 * @return
+	 */
 	public static DbFieldType fromClass(Class<?> klass) {
 		if (klass == Boolean.class || klass == boolean.class) {
 			return BOOLEAN;
diff --git a/src/main/java/tech/ailef/dbadmin/external/package-info.java b/src/main/java/tech/ailef/dbadmin/external/package-info.java
index faedcdf..031fed6 100644
--- a/src/main/java/tech/ailef/dbadmin/external/package-info.java
+++ b/src/main/java/tech/ailef/dbadmin/external/package-info.java
@@ -17,6 +17,9 @@
  */
 
 /**
- * Root package of Spring Boot Database Admin
+ * Root package of Spring Boot Database Admin.
+ * 
+ * It contains the configuration class which handles the initialization
+ * and the main {@link tech.ailef.dbadmin.external.DbAdmin} class.
  */
 package tech.ailef.dbadmin.external;
\ No newline at end of file