Skip to content

Commit

Permalink
doc(newToadPattern): add missing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hozlucas28 committed Sep 13, 2024
1 parent 3a96824 commit c608512
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion libs/patterns/constructors.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,15 @@ void newGliderCannonPattern(TPattern* pattern);
*/
void newPressPattern(TPattern* pattern);

// TODO: Documentation
/**
* @brief Initializes a new Toad pattern.
*
* This function sets up a new Toad pattern by initializing the provided pattern structure.
* The Toad is a pattern of cells that oscillates with a period of 2 generations in a Conway's Game
* of Life grid.
*
* @param pattern Pointer to the pattern structure to be initialized with the Toad pattern.
*/
void newToadPattern(TPattern* pattern);

#endif // PATTERNS_CONSTRUCTORS_H_INCLUDED

0 comments on commit c608512

Please sign in to comment.