From 87b99fab9dd46d5a2b3773bb0f87c56cef70c5d7 Mon Sep 17 00:00:00 2001
From: gabriel-logan <gabrielcoutolima@protonmail.ch>
Date: Sun, 14 Jul 2024 23:37:31 -0300
Subject: [PATCH] chore: Update Javadoc links in documentation files and
 documentation

---
 .idea/workspace.xml                         | 24 +--------------------
 README.md                                   |  4 ++++
 docs/content/classes/CnpjValidator.md       |  6 +-----
 docs/content/classes/CpfValidator.md        |  6 +-----
 docs/content/classes/CreditCardValidator.md |  6 +-----
 docs/content/classes/FileValidator.md       |  6 +-----
 docs/content/classes/Utils.md               |  6 +-----
 docs/content/classes/Validate.md            |  6 +-----
 docs/content/classes/Validator.md           |  6 +-----
 9 files changed, 12 insertions(+), 58 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index a9cc084..3e557f3 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -4,29 +4,7 @@
     <option name="autoReloadType" value="SELECTIVE" />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="22c9667a-e00d-49e2-aa6d-da35dd213aa7" name="Changes" comment="">
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/issuestore/1/5/15a6e0cffdd20108561c3ba173365425592a9cce" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/issuestore/3/7/37a2bd0ac1d596813e668677d4cda443af3c82b2" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/issuestore/9/f/9f7cbce127b94a94ee14460050fbff2ce58417d0" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/issuestore/b/6/b6f27eeb3cb5e9201c2c6debd7aba2209523a60d" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/issuestore/d/8/d87f992b2bfe5407921c143a17dddc1c48818247" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/issuestore/e/3/e39d43ca39384f3ae643880ba15c91da9db36261" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/issuestore/e/f/ef5c795fa997c1fde7572ebc50019a7f542b6de3" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/issuestore/f/1/f1a6ae1a81b2873e9d16979d220bb8e583eeed3c" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/issuestore/f/c/fc5c40cf56bde0ed00f702912040d14c7a3d163d" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/issuestore/index.pb" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/sonarlint/issuestore/index.pb" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/securityhotspotstore/1/5/15a6e0cffdd20108561c3ba173365425592a9cce" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/securityhotspotstore/3/7/37a2bd0ac1d596813e668677d4cda443af3c82b2" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/securityhotspotstore/9/f/9f7cbce127b94a94ee14460050fbff2ce58417d0" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/securityhotspotstore/b/6/b6f27eeb3cb5e9201c2c6debd7aba2209523a60d" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/securityhotspotstore/d/8/d87f992b2bfe5407921c143a17dddc1c48818247" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/securityhotspotstore/e/3/e39d43ca39384f3ae643880ba15c91da9db36261" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/securityhotspotstore/e/f/ef5c795fa997c1fde7572ebc50019a7f542b6de3" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/securityhotspotstore/f/1/f1a6ae1a81b2873e9d16979d220bb8e583eeed3c" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/securityhotspotstore/f/c/fc5c40cf56bde0ed00f702912040d14c7a3d163d" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/sonarlint/securityhotspotstore/index.pb" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/sonarlint/securityhotspotstore/index.pb" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-    </list>
+    <list default="true" id="22c9667a-e00d-49e2-aa6d-da35dd213aa7" name="Changes" comment="" />
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
     <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
diff --git a/README.md b/README.md
index 1d5f50d..3dd7909 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,10 @@ follow the steps below to use the library in your project.
 
 See the documentation for more information.
 
+- [Javadoc](https://multiform-validator.github.io/java/api/)
+
+or
+
 - [Multiform Validator - Web doc](https://multiform-validator.github.io/java/)
 
 or
diff --git a/docs/content/classes/CnpjValidator.md b/docs/content/classes/CnpjValidator.md
index 4d624d5..c2db777 100644
--- a/docs/content/classes/CnpjValidator.md
+++ b/docs/content/classes/CnpjValidator.md
@@ -1,5 +1,3 @@
-# CnpjValidator
-
 The `CnpjValidator` class is used to validate CNPJ numbers. It has a single method, `cnpjIsValid`, which receives
 a `String` as a parameter and returns a `boolean` value.
 
@@ -35,6 +33,4 @@ public class Main {
 - [FileValidator](https://multiform-validator.github.io/java/classes/FileValidator)
 - [Utils](https://multiform-validator.github.io/java/classes/Utils)
 - [Validate](https://multiform-validator.github.io/java/classes/Validate)
-- [Validator](https://multiform-validator.github.io/java/classes/Validator)
-
-## Return to [Home](https://multiform-validator.github.io/java/)
\ No newline at end of file
+- [Validator](https://multiform-validator.github.io/java/classes/Validator)
\ No newline at end of file
diff --git a/docs/content/classes/CpfValidator.md b/docs/content/classes/CpfValidator.md
index 009d822..433098d 100644
--- a/docs/content/classes/CpfValidator.md
+++ b/docs/content/classes/CpfValidator.md
@@ -1,5 +1,3 @@
-# CpfValidator
-
 The `CpfValidator` class is used to validate CPF numbers. It has a single method, `cpfIsValid`, which receives
 a `String` as a parameter and returns a `boolean` value.
 
@@ -27,6 +25,4 @@ public class Main {
 - [FileValidator](https://multiform-validator.github.io/java/classes/FileValidator)
 - [Utils](https://multiform-validator.github.io/java/classes/Utils)
 - [Validate](https://multiform-validator.github.io/java/classes/Validate)
-- [Validator](https://multiform-validator.github.io/java/classes/Validator)
-
-## Return to [Home](https://multiform-validator.github.io/java/)
\ No newline at end of file
+- [Validator](https://multiform-validator.github.io/java/classes/Validator)
\ No newline at end of file
diff --git a/docs/content/classes/CreditCardValidator.md b/docs/content/classes/CreditCardValidator.md
index 1656208..1f59424 100644
--- a/docs/content/classes/CreditCardValidator.md
+++ b/docs/content/classes/CreditCardValidator.md
@@ -1,5 +1,3 @@
-# CreditCardValidator
-
 The `CreditCardValidator` class is used to validate credit card numbers. It has two methods, `isCreditCardValid`
 and `identifyCreditCard`.
 
@@ -46,6 +44,4 @@ public class Main {
 - [FileValidator](https://multiform-validator.github.io/java/classes/FileValidator)
 - [Utils](https://multiform-validator.github.io/java/classes/Utils)
 - [Validate](https://multiform-validator.github.io/java/classes/Validate)
-- [Validator](https://multiform-validator.github.io/java/classes/Validator)
-
-## Return to [Home](https://multiform-validator.github.io/java/)
\ No newline at end of file
+- [Validator](https://multiform-validator.github.io/java/classes/Validator)
\ No newline at end of file
diff --git a/docs/content/classes/FileValidator.md b/docs/content/classes/FileValidator.md
index f503e96..7bf61d5 100644
--- a/docs/content/classes/FileValidator.md
+++ b/docs/content/classes/FileValidator.md
@@ -1,5 +1,3 @@
-# FileValidator
-
 The `FileValidator` class is used to validate files. It has the following methods:
 
 - isValidAudio
@@ -111,6 +109,4 @@ public class Main {
 - [CreditCardValidator](https://multiform-validator.github.io/java/classes/CreditCardValidator)
 - [Utils](https://multiform-validator.github.io/java/classes/Utils)
 - [Validate](https://multiform-validator.github.io/java/classes/Validate)
-- [Validator](https://multiform-validator.github.io/java/classes/Validator)
-
-## Return to [Home](https://multiform-validator.github.io/java/)
\ No newline at end of file
+- [Validator](https://multiform-validator.github.io/java/classes/Validator)
\ No newline at end of file
diff --git a/docs/content/classes/Utils.md b/docs/content/classes/Utils.md
index 1f5fe31..6533d97 100644
--- a/docs/content/classes/Utils.md
+++ b/docs/content/classes/Utils.md
@@ -1,5 +1,3 @@
-# Utils
-
 The `Utils` class is a utility class with some methods to help you with some common tasks. It has the following
 methods:
 
@@ -38,6 +36,4 @@ public class Main {
 - [CreditCardValidator](https://multiform-validator.github.io/java/classes/CreditCardValidator)
 - [FileValidator](https://multiform-validator.github.io/java/classes/FileValidator)
 - [Validate](https://multiform-validator.github.io/java/classes/Validate)
-- [Validator](https://multiform-validator.github.io/java/classes/Validator)
-
-## Return to [Home](https://multiform-validator.github.io/java/)
\ No newline at end of file
+- [Validator](https://multiform-validator.github.io/java/classes/Validator)
\ No newline at end of file
diff --git a/docs/content/classes/Validate.md b/docs/content/classes/Validate.md
index 7894e40..433b093 100644
--- a/docs/content/classes/Validate.md
+++ b/docs/content/classes/Validate.md
@@ -1,5 +1,3 @@
-# Validate
-
 The `Validate` class is a utility class with some methods to validate data. It has the following methods:
 
 - validateEmail
@@ -78,6 +76,4 @@ public class Main {
 - [CreditCardValidator](https://multiform-validator.github.io/java/classes/CreditCardValidator)
 - [FileValidator](https://multiform-validator.github.io/java/classes/FileValidator)
 - [Utils](https://multiform-validator.github.io/java/classes/Utils)
-- [Validator](https://multiform-validator.github.io/java/classes/Validator)
-
-## Return to [Home](https://multiform-validator.github.io/java/)
\ No newline at end of file
+- [Validator](https://multiform-validator.github.io/java/classes/Validator)
\ No newline at end of file
diff --git a/docs/content/classes/Validator.md b/docs/content/classes/Validator.md
index 0cd1e01..f422605 100644
--- a/docs/content/classes/Validator.md
+++ b/docs/content/classes/Validator.md
@@ -1,5 +1,3 @@
-# Validator
-
 The `Validator` class is used to validate some common data types. It has the following methods:
 
 - isAscii
@@ -265,6 +263,4 @@ public class Main {
 - [CreditCardValidator](https://multiform-validator.github.io/java/classes/CreditCardValidator)
 - [FileValidator](https://multiform-validator.github.io/java/classes/FileValidator)
 - [Utils](https://multiform-validator.github.io/java/classes/Utils)
-- [Validate](https://multiform-validator.github.io/java/classes/Validate)
-
-## Return to [Home](https://multiform-validator.github.io/java/)
\ No newline at end of file
+- [Validate](https://multiform-validator.github.io/java/classes/Validate)
\ No newline at end of file