Improve comments.
authorEric S. Raymond <esr@thyrsus.com>
Mon, 18 Apr 2022 22:07:28 +0000 (18:07 -0400)
committerEric S. Raymond <esr@thyrsus.com>
Tue, 19 Apr 2022 20:36:20 +0000 (16:36 -0400)
main.c
misc.c
templates/dungeon.h.tpl

diff --git a/main.c b/main.c
index eb8936214e16cbc90c75d665124da1c6e044f870..809574b6c35cc82e02208a05862133463aa26e2b 100644 (file)
--- a/main.c
+++ b/main.c
@@ -255,7 +255,7 @@ static void checkhints(void)
                     game.hintlc[hint] = 0;
                     return;
                 default: // LCOV_EXCL_LINE
-                    // Should never hap[pen
+                    // Should never happen
                     BUG(HINT_NUMBER_EXCEEDS_GOTO_LIST); // LCOV_EXCL_LINE
                 }
 
diff --git a/misc.c b/misc.c
index 968e2a1840d5a6acc6c04a79c44bfcaf418a95ee..35c4e4b46b1f41dbf60f2aac877d6c6bd88b8dbf 100644 (file)
--- a/misc.c
+++ b/misc.c
@@ -35,6 +35,7 @@ static void* xcalloc(size_t size)
 /*  I/O routines (speak, pspeak, rspeak, sspeak, get_input, yes) */
 
 static void vspeak(const char* msg, bool blank, va_list ap)
+/* Engine for various speak functions */
 {
     // Do nothing if we got a null pointer.
     if (msg == NULL)
@@ -122,6 +123,7 @@ static void vspeak(const char* msg, bool blank, va_list ap)
 }
 
 void speak(const char* msg, ...)
+/* speak a specified string */
 {
     va_list ap;
     va_start(ap, msg);
@@ -130,6 +132,7 @@ void speak(const char* msg, ...)
 }
 
 void sspeak(const int msg, ...)
+/* Speak a message from the arbitrary-messages list */
 {
     va_list ap;
     va_start(ap, msg);
index 4dde750a319d0be6f755fa3f4ef320e046886994..8c07ed523f9315063591dcdedd66e7b1d4dcd520 100644 (file)
@@ -12,7 +12,7 @@
 #define COND_FLUID     2       /* Liquid asset, see bit 1 */
 #define COND_NOARRR    3       /* Pirate doesn't go here unless following */
 #define COND_NOBACK    4       /* Cannot use "back" to move away */
-#define COND_ABOVE     5
+#define COND_ABOVE     5       /* Aboveground, but not in forest */
 #define COND_DEEP      6       /* Deep - e.g where dwarves are active */
 #define COND_FOREST    7       /* In the forest */
 #define COND_FORCED    8       /* Only one way in or out of here */
@@ -162,4 +162,4 @@ enum action_refs {{
 
 {state_definitions}
 
-#endif /* end DUNGEON_H */
\ No newline at end of file
+#endif /* end DUNGEON_H */