From 9ba6a5b8ea2ddd8f71df4a61e7b9cd098b9eec59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miloslav=20=C4=8C=C3=AD=C5=BE?= Date: Sat, 7 Nov 2020 18:58:40 +0100 Subject: [PATCH] Fix comments --- constants.h | 2 +- game.h | 6 +++--- images.h | 2 +- levels.h | 2 +- main_gbmeta.ino | 2 +- main_pokitto.cpp | 2 +- main_sdl.c | 7 +++---- main_test.c | 4 +++- settings.h | 2 +- sounds.h | 2 +- 10 files changed, 16 insertions(+), 15 deletions(-) diff --git a/constants.h b/constants.h index a9fc526..f573d86 100644 --- a/constants.h +++ b/constants.h @@ -8,7 +8,7 @@ by Miloslav Ciz (drummyfish), 2019 Released under CC0 1.0 (https://creativecommons.org/publicdomain/zero/1.0/) - plus a waiver of all other intellectual property. The goal of this work is + plus a waiver of all other intellectual property. The goal of this work is to be and remain completely in the public domain forever, available for any use whatsoever. */ diff --git a/game.h b/game.h index 2ee0e8f..c1ca811 100755 --- a/game.h +++ b/game.h @@ -425,7 +425,7 @@ struct uint32_t lastItemTakenFrame; uint8_t ammo[SFG_AMMO_TOTAL]; uint8_t cards; /**< Lowest 3 bits say which access cards - have been taken., the next 3 bits say + have been taken, the next 3 bits say which cards should be blinking in the HUD, the last 2 bits are a blink reset counter. */ uint8_t justTeleported; @@ -442,7 +442,7 @@ struct const uint8_t* textures[7]; ///< textures the level is using uint32_t timeStart; uint32_t frameStart; - uint32_t completionTime10sOfS; ///< completion time in 10th of second + uint32_t completionTime10sOfS; ///< completion time in 10ths of second uint8_t floorColor; uint8_t ceilingColor; @@ -1738,7 +1738,7 @@ void SFG_init() } /** - Adds new projectile to the current level, return 1 if added, 0 if not (max + Adds new projectile to the current level, returns 1 if added, 0 if not (max count reached). */ uint8_t SFG_createProjectile(SFG_ProjectileRecord projectile) diff --git a/images.h b/images.h index 569f426..661f558 100644 --- a/images.h +++ b/images.h @@ -12,7 +12,7 @@ by Miloslav Ciz (drummyfish), 2019 Released under CC0 1.0 (https://creativecommons.org/publicdomain/zero/1.0/) - plus a waiver of all other intellectual property. The goal of this work is + plus a waiver of all other intellectual property. The goal of this work is to be and remain completely in the public domain forever, available for any use whatsoever. */ diff --git a/levels.h b/levels.h index 8ebdd75..049d63a 100644 --- a/levels.h +++ b/levels.h @@ -6,7 +6,7 @@ by Miloslav Ciz (drummyfish), 2019 Released under CC0 1.0 (https://creativecommons.org/publicdomain/zero/1.0/) - plus a waiver of all other intellectual property. The goal of this work is + plus a waiver of all other intellectual property. The goal of this work is to be and remain completely in the public domain forever, available for any use whatsoever. */ diff --git a/main_gbmeta.ino b/main_gbmeta.ino index 8df9734..d4fd2d3 100644 --- a/main_gbmeta.ino +++ b/main_gbmeta.ino @@ -15,7 +15,7 @@ by Miloslav Ciz (drummyfish), 2019 Released under CC0 1.0 (https://creativecommons.org/publicdomain/zero/1.0/) - plus a waiver of all other intellectual property. The goal of this work is + plus a waiver of all other intellectual property. The goal of this work is to be and remain completely in the public domain forever, available for any use whatsoever. */ diff --git a/main_pokitto.cpp b/main_pokitto.cpp index 766ddbb..7c5d6cb 100644 --- a/main_pokitto.cpp +++ b/main_pokitto.cpp @@ -7,7 +7,7 @@ by Miloslav Ciz (drummyfish), 2019 Released under CC0 1.0 (https://creativecommons.org/publicdomain/zero/1.0/) - plus a waiver of all other intellectual property. The goal of this work is + plus a waiver of all other intellectual property. The goal of this work is to be and remain completely in the public domain forever, available for any use whatsoever. */ diff --git a/main_sdl.c b/main_sdl.c index 692f749..45e57fe 100644 --- a/main_sdl.c +++ b/main_sdl.c @@ -5,9 +5,8 @@ compile a native executable or a transpiled JS browser version with emscripten. - This front end is pretty feature rich, allowing testing etc. A much more - minimal could be made. If you want a learning example of front end, look at - another, simpler one, e.g. the terminal. + This frontend is not strictly minimal, it could be reduced a lot. If you want + a learning example of frontend, look at another, simpler one, e.g. terminal. To compile with emscripten run: @@ -16,7 +15,7 @@ by Miloslav Ciz (drummyfish), 2019 Released under CC0 1.0 (https://creativecommons.org/publicdomain/zero/1.0/) - plus a waiver of all other intellectual property. The goal of this work is + plus a waiver of all other intellectual property. The goal of this work is to be and remain completely in the public domain forever, available for any use whatsoever. */ diff --git a/main_test.c b/main_test.c index 1bec1c8..bb97a7b 100644 --- a/main_test.c +++ b/main_test.c @@ -1,7 +1,9 @@ /** @file main_test.c - This is a front end that serves as a basic automatic test of the game. + This is a front end that serves as a basic automatic test of the game. At this + point it's very simple and basically just checks if anything really + substantial wasn't broken. This fronted tries to play the game and see if it behaves how expected. If you change anything substantial in the game, this test may start to fail and you diff --git a/settings.h b/settings.h index c537b04..c42a7c0 100644 --- a/settings.h +++ b/settings.h @@ -11,7 +11,7 @@ by Miloslav Ciz (drummyfish), 2019 Released under CC0 1.0 (https://creativecommons.org/publicdomain/zero/1.0/) - plus a waiver of all other intellectual property. The goal of this work is + plus a waiver of all other intellectual property. The goal of this work is to be and remain completely in the public domain forever, available for any use whatsoever. */ diff --git a/sounds.h b/sounds.h index 39b4df0..2e2b042 100644 --- a/sounds.h +++ b/sounds.h @@ -15,7 +15,7 @@ by Miloslav Ciz (drummyfish), 2019 Released under CC0 1.0 (https://creativecommons.org/publicdomain/zero/1.0/) - plus a waiver of all other intellectual property. The goal of this work is + plus a waiver of all other intellectual property. The goal of this work is to be and remain completely in the public domain forever, available for any use whatsoever. */