From: Eric S. Raymond <esr@thyrsus.com>
Date: Mon, 18 Apr 2022 22:07:28 +0000 (-0400)
Subject: Improve comments.
X-Git-Tag: 1.12~16
X-Git-Url: https://jxself.org/git/?a=commitdiff_plain;h=9af3ab4ecddbd6dd0347a4adc54a98b5153a9fb6;p=open-adventure.git

Improve comments.
---

diff --git a/main.c b/main.c
index eb89362..809574b 100644
--- 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 968e2a1..35c4e4b 100644
--- 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);
diff --git a/templates/dungeon.h.tpl b/templates/dungeon.h.tpl
index 4dde750..8c07ed5 100644
--- a/templates/dungeon.h.tpl
+++ b/templates/dungeon.h.tpl
@@ -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 */