Skip to content

Commit

Permalink
doc(macros.h): add missing documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
hozlucas28 committed Sep 12, 2024
1 parent faf3c8a commit d72b595
Showing 1 changed file with 34 additions and 6 deletions.
40 changes: 34 additions & 6 deletions libs/patterns/macros.h
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit d72b595

Please sign in to comment.