Code cleanup and documentation

This commit is contained in:
2025-10-18 21:35:01 +02:00
parent 6b0e858064
commit e124e3071e
17 changed files with 105 additions and 95 deletions

View File

@@ -1,8 +1,7 @@
/*
* Created by snapshot112 on 10/15/25.
* Created by snapshot112 on 15/10/2025.
*
* A game engine that uses the can run and display games in rectangular grids.
* The graphics are made using ncurses.
* A game engine build on top of a grid api to run and display games using ncurses.
*
* Please make sure to initialize the game engine before running any games.
*/
@@ -133,12 +132,12 @@ void update_grid(grid *gp, char c, int x, int y);
void game_exit_message(const grid *gp, coordinate location);
/*
* Waits for you to press ENTER or SPACE before exiting the game.
* Waits for you to press ENTER before exiting the game.
*
* Input:
* coordinate: The location to show the message.
*
* Side effect: Prints "Press ENTER or SPACE to exit." game to the console.
* Side effect: Prints "Press ENTER to exit." game to the console.
*/
void graceful_exit(coordinate message_location);