File tree 1 file changed +34
-6
lines changed
1 file changed +34
-6
lines changed Original file line number Diff line number Diff line change 2
2
#ifndef PATTERNS_MACROS_H_INCLUDED
3
3
#define PATTERNS_MACROS_H_INCLUDED
4
4
5
- // TODO: Documentation
5
+ /**
6
+ * @def ALIVE_CELL
7
+ * @brief Represents a live cell.
8
+ *
9
+ * @warning The value of `ALIVE_CELL` must be a single character.
10
+ */
6
11
#define ALIVE_CELL 'o'
7
12
8
- // TODO: Documentation
13
+ /**
14
+ * @def DEAD_CELL
15
+ * @brief Represents a dead cell.
16
+ *
17
+ * @warning The value of `DEAD_CELL` must be a single character.
18
+ */
9
19
#define DEAD_CELL ' '
10
20
11
- // TODO: Documentation
12
- #define PATTERN_COLS 36
13
-
14
- // TODO: Documentation
21
+ /**
22
+ * @def PATTERN_ROWS
23
+ * @brief Defines the number of rows in a 2D array pattern.
24
+ *
25
+ * This macro is used to define the number of rows in a 2D array pattern.
26
+ * It is typically used in conjunction with the `PATTERN_COLS` macro to define
27
+ * the size of a pattern.
28
+ *
29
+ * @warning The value of `PATTERN_ROWS` should be a positive integer.
30
+ */
15
31
#define PATTERN_ROWS 13
16
32
33
+ /**
34
+ * @def PATTERN_COLS
35
+ * @brief Defines the number of columns in a 2D array pattern.
36
+ *
37
+ * This macro is used to define the number of columns in a 2D array pattern.
38
+ * It is typically used in conjunction with the `PATTERN_ROWS` macro to define
39
+ * the size of a pattern.
40
+ *
41
+ * @warning The value of `PATTERN_COLS` should be a positive integer.
42
+ */
43
+ #define PATTERN_COLS 36
44
+
17
45
#endif // PATTERNS_MACROS_H_INCLUDED
You can’t perform that action at this time.
0 commit comments