Skip to content

Commit

Permalink
chore: Update Javadoc links in documentation files and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gabriel-logan committed Jul 15, 2024
1 parent 132f296 commit 87b99fa
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 58 deletions.
24 changes: 1 addition & 23 deletions .idea/workspace.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 1 addition & 5 deletions docs/content/classes/CnpjValidator.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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/)
- [Validator](https://multiform-validator.github.io/java/classes/Validator)
6 changes: 1 addition & 5 deletions docs/content/classes/CpfValidator.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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/)
- [Validator](https://multiform-validator.github.io/java/classes/Validator)
6 changes: 1 addition & 5 deletions docs/content/classes/CreditCardValidator.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# CreditCardValidator

The `CreditCardValidator` class is used to validate credit card numbers. It has two methods, `isCreditCardValid`
and `identifyCreditCard`.

Expand Down Expand Up @@ -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/)
- [Validator](https://multiform-validator.github.io/java/classes/Validator)
6 changes: 1 addition & 5 deletions docs/content/classes/FileValidator.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# FileValidator

The `FileValidator` class is used to validate files. It has the following methods:

- isValidAudio
Expand Down Expand Up @@ -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/)
- [Validator](https://multiform-validator.github.io/java/classes/Validator)
6 changes: 1 addition & 5 deletions docs/content/classes/Utils.md
Original file line number Diff line number Diff line change
@@ -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:

Expand Down Expand Up @@ -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/)
- [Validator](https://multiform-validator.github.io/java/classes/Validator)
6 changes: 1 addition & 5 deletions docs/content/classes/Validate.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# Validate

The `Validate` class is a utility class with some methods to validate data. It has the following methods:

- validateEmail
Expand Down Expand Up @@ -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/)
- [Validator](https://multiform-validator.github.io/java/classes/Validator)
6 changes: 1 addition & 5 deletions docs/content/classes/Validator.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# Validator

The `Validator` class is used to validate some common data types. It has the following methods:

- isAscii
Expand Down Expand Up @@ -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/)
- [Validate](https://multiform-validator.github.io/java/classes/Validate)

0 comments on commit 87b99fa

Please sign in to comment.