From 63c1dea7a2994f3a15cb8ccce0aa6eb625245a7f Mon Sep 17 00:00:00 2001 From: Raphael Date: Fri, 5 Sep 2025 16:28:33 +0200 Subject: [PATCH] docs(char): moving the actual documentation on the header - The documentation on the header allow u to see on the files where the header is inclued --- char/ft_isalnum.c | 8 +------- char/ft_isalpha.c | 8 +------- char/ft_isascii.c | 8 +------- char/ft_isdigit.c | 8 +------- char/ft_isprint.c | 8 +------- char/ft_tolower.c | 8 +------- char/ft_toupper.c | 8 +------- includes/char.h | 50 ++++++++++++++++++++++++++++++++++++++++++++++- 8 files changed, 56 insertions(+), 50 deletions(-) diff --git a/char/ft_isalnum.c b/char/ft_isalnum.c index 189f919..f36023a 100644 --- a/char/ft_isalnum.c +++ b/char/ft_isalnum.c @@ -6,18 +6,12 @@ /* By: rparodi +#+ +:+ +#+ */ /* +#+#+#+#+#+ +#+ */ /* Created: 2023/11/06 12:47:28 by rparodi #+# #+# */ -/* Updated: 2025/09/04 18:12:52 by rparodi ### ########.fr */ +/* Updated: 2025/09/05 16:01:38 by rparodi ### ########.fr */ /* */ /* ************************************************************************** */ #include "char.h" -/** - * @brief Check if the character is alpha-numeric - * - * @param c the character - * @return the character if alphanumeric or 0 if not - */ int ft_isalnum(int c) { if (ft_isalpha(c) || ft_isdigit(c)) diff --git a/char/ft_isalpha.c b/char/ft_isalpha.c index a543c4c..be64e5a 100644 --- a/char/ft_isalpha.c +++ b/char/ft_isalpha.c @@ -6,16 +6,10 @@ /* By: rparodi +#+ +:+ +#+ */ /* +#+#+#+#+#+ +#+ */ /* Created: 2023/11/06 11:58:37 by rparodi #+# #+# */ -/* Updated: 2025/09/04 18:13:06 by rparodi ### ########.fr */ +/* Updated: 2025/09/05 16:03:14 by rparodi ### ########.fr */ /* */ /* ************************************************************************** */ -/** - * @brief Check if the character is alpha - * - * @param c the character - * @return the character if alpha or 0 if not - */ int ft_isalpha(int c) { if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')) diff --git a/char/ft_isascii.c b/char/ft_isascii.c index 8ed7e6d..c36b984 100644 --- a/char/ft_isascii.c +++ b/char/ft_isascii.c @@ -6,16 +6,10 @@ /* By: rparodi +#+ +:+ +#+ */ /* +#+#+#+#+#+ +#+ */ /* Created: 2023/11/06 14:04:26 by rparodi #+# #+# */ -/* Updated: 2025/09/05 10:40:03 by rparodi ### ########.fr */ +/* Updated: 2025/09/05 16:01:13 by rparodi ### ########.fr */ /* */ /* ************************************************************************** */ -/** - * @brief Check if the character is in the ascii table - * - * @param c the character - * @return the character if in the ascii table or 0 if not - */ int ft_isascii(int c) { if (c == 0) diff --git a/char/ft_isdigit.c b/char/ft_isdigit.c index 379f867..fd464ad 100644 --- a/char/ft_isdigit.c +++ b/char/ft_isdigit.c @@ -6,16 +6,10 @@ /* By: rparodi +#+ +:+ +#+ */ /* +#+#+#+#+#+ +#+ */ /* Created: 2023/11/06 12:44:28 by rparodi #+# #+# */ -/* Updated: 2025/09/04 18:13:17 by rparodi ### ########.fr */ +/* Updated: 2025/09/05 16:00:16 by rparodi ### ########.fr */ /* */ /* ************************************************************************** */ -/** - * @brief Check if the character is alpha numeric - * - * @param c the character - * @return the character if numeric or 0 if not - */ int ft_isdigit(int c) { if (c >= '0' && c <= '9') diff --git a/char/ft_isprint.c b/char/ft_isprint.c index c4c38c4..7bdd052 100644 --- a/char/ft_isprint.c +++ b/char/ft_isprint.c @@ -6,16 +6,10 @@ /* By: rparodi +#+ +:+ +#+ */ /* +#+#+#+#+#+ +#+ */ /* Created: 2023/11/06 14:06:53 by rparodi #+# #+# */ -/* Updated: 2025/09/05 10:44:13 by rparodi ### ########.fr */ +/* Updated: 2025/09/05 16:03:14 by rparodi ### ########.fr */ /* */ /* ************************************************************************** */ -/** - * @brief Check if the character is printable - * - * @param c the character - * @return the character if can be print or 0 if not - */ int ft_isprint(int c) { if (c >= 32 && c <= 126) diff --git a/char/ft_tolower.c b/char/ft_tolower.c index 525223a..d5e7d1c 100644 --- a/char/ft_tolower.c +++ b/char/ft_tolower.c @@ -6,16 +6,10 @@ /* By: rparodi +#+ +:+ +#+ */ /* +#+#+#+#+#+ +#+ */ /* Created: 2023/11/07 10:38:54 by rparodi #+# #+# */ -/* Updated: 2025/09/04 11:42:13 by rparodi ### ########.fr */ +/* Updated: 2025/09/05 16:00:45 by rparodi ### ########.fr */ /* */ /* ************************************************************************** */ -/** - * @brief convert the upper case to lower case - * - * @param c the character - * @return the character to lower case if is on upper - */ int ft_tolower(int c) { if (c >= 'A' && c <= 'Z') diff --git a/char/ft_toupper.c b/char/ft_toupper.c index fed811d..921cca5 100644 --- a/char/ft_toupper.c +++ b/char/ft_toupper.c @@ -6,16 +6,10 @@ /* By: rparodi +#+ +:+ +#+ */ /* +#+#+#+#+#+ +#+ */ /* Created: 2023/11/07 10:44:26 by rparodi #+# #+# */ -/* Updated: 2025/09/04 11:41:57 by rparodi ### ########.fr */ +/* Updated: 2025/09/05 16:00:45 by rparodi ### ########.fr */ /* */ /* ************************************************************************** */ -/** - * @brief convert the lower case to upper case - * - * @param c the character - * @return the character to upper case if is on lower - */ int ft_toupper(int c) { if (c >= 'a' && c <= 'z') diff --git a/includes/char.h b/includes/char.h index ac26e90..394e408 100644 --- a/includes/char.h +++ b/includes/char.h @@ -6,19 +6,67 @@ /* By: rparodi +#+ +:+ +#+ */ /* +#+#+#+#+#+ +#+ */ /* Created: 2024/10/31 14:54:04 by rparodi #+# #+# */ -/* Updated: 2025/09/01 18:26:44 by rparodi ### ########.fr */ +/* Updated: 2025/09/05 16:06:07 by rparodi ### ########.fr */ /* */ /* ************************************************************************** */ #ifndef CHAR_H # define CHAR_H +/** + * @brief Check if the character is alpha-numeric + * + * @param c the character + * @return 1 if the char is alpha-numeric overwise 0 + */ int ft_isalnum(int c); + +/** + * @brief Check if the character is alpha + * + * @param c the character + * @return 1 if the char is alphabetic overwise 0 + */ int ft_isalpha(int c); + +/** + * @brief Check if the character is in the ascii table + * + * @param c the character + * @return 1 if the char is ascii overwise 0 + */ int ft_isascii(int c); + +/** + * @brief Check if the character is numeric + * + * @param c the character + * @return 1 if the char is numeric overwise 0 + */ int ft_isdigit(int c); + +/** + * @brief Check if the character is printable + * + * @param c the character + * @return 1 if the char is printable 0 + */ int ft_isprint(int c); + +/** + * @brief convert the upper case to lower case + * + * @param c the character + * @return the character to lower case if is on upper + */ int ft_tolower(int c); + +/** + * @brief convert the lower case to upper case + * + * @param c the character + * @return the character to upper case if is on lower + */ int ft_toupper(int c); #endif