Skip to content

Commit f55a272

Browse files
committed
doc: add documentation for startGameBySDL function
1 parent 4055ae3 commit f55a272

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/sdl/methods.h

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,15 @@
33

44
#include "../../libs/main.h"
55

6-
// TODO: Documentation
6+
/**
7+
* @brief Starts a Conway's Game of Life game using the SDL library for display.
8+
*
9+
* @param pGame Pointer to a Conway's Game of Life structure.
10+
* @param maxGeneration Maximum number of generations.
11+
* @param delayBetweenGenerations Delay in milliseconds between each generation.
12+
*
13+
* @warning This function assumes that `pGame` has been properly initialized.
14+
*/
715
int startGameBySDL(TGame* pGame, int maxGeneration, int delayBetweenGenerations);
816

917
#endif // SDL_METHODS_H_INCLUDED

0 commit comments

Comments
 (0)