From d72b595784dacdffd2c50b9d413ab740a8dd4a4f Mon Sep 17 00:00:00 2001 From: hozlucas28 Date: Thu, 12 Sep 2024 20:42:48 -0300 Subject: [PATCH] doc(macros.h): add missing documentations --- libs/patterns/macros.h | 40 ++++++++++++++++++++++++++++++++++------ 1 file changed, 34 insertions(+), 6 deletions(-) diff --git a/libs/patterns/macros.h b/libs/patterns/macros.h index 054b472..db7f128 100644 --- a/libs/patterns/macros.h +++ b/libs/patterns/macros.h @@ -2,16 +2,44 @@ #ifndef PATTERNS_MACROS_H_INCLUDED #define PATTERNS_MACROS_H_INCLUDED -// TODO: Documentation +/** + * @def ALIVE_CELL + * @brief Represents a live cell. + * + * @warning The value of `ALIVE_CELL` must be a single character. + */ #define ALIVE_CELL 'o' -// TODO: Documentation +/** + * @def DEAD_CELL + * @brief Represents a dead cell. + * + * @warning The value of `DEAD_CELL` must be a single character. + */ #define DEAD_CELL ' ' -// TODO: Documentation -#define PATTERN_COLS 36 - -// TODO: Documentation +/** + * @def PATTERN_ROWS + * @brief Defines the number of rows in a 2D array pattern. + * + * This macro is used to define the number of rows in a 2D array pattern. + * It is typically used in conjunction with the `PATTERN_COLS` macro to define + * the size of a pattern. + * + * @warning The value of `PATTERN_ROWS` should be a positive integer. + */ #define PATTERN_ROWS 13 +/** + * @def PATTERN_COLS + * @brief Defines the number of columns in a 2D array pattern. + * + * This macro is used to define the number of columns in a 2D array pattern. + * It is typically used in conjunction with the `PATTERN_ROWS` macro to define + * the size of a pattern. + * + * @warning The value of `PATTERN_COLS` should be a positive integer. + */ +#define PATTERN_COLS 36 + #endif // PATTERNS_MACROS_H_INCLUDED