From: Eric S. Raymond <esr@thyrsus.com>
Date: Thu, 20 Jul 2017 18:46:50 +0000 (-0400)
Subject: Comment cleanup.
X-Git-Tag: 1.3~25
X-Git-Url: https://jxself.org/git/?a=commitdiff_plain;h=535d9e7964e0033d42f01639ac9dc0e3b169d956;p=open-adventure.git

Comment cleanup.
---

diff --git a/advent.h b/advent.h
index 3ed084f..b058797 100644
--- a/advent.h
+++ b/advent.h
@@ -117,8 +117,8 @@ typedef long loc_t;    // index into the locations array */
 
 struct game_t {
     unsigned long lcg_a, lcg_c, lcg_m, lcg_x;
-    long abbnum;                 // How often to print non-abbreviated descriptions
-    score_t bonus;                  // What kind of bonus we are getting for finishing the game
+    long abbnum;                 // How often to print long descriptions
+    score_t bonus;               // What kind of finishing bonus we are getting
     long chloc;
     long chloc2;
     long clock1;                 // # turns from finding last treasure till closing
@@ -126,7 +126,7 @@ struct game_t {
     bool clshnt;                 // has player read the clue in the endgame?
     bool closed;                 // whether we're all the way closed
     bool closng;                 // whether it's closing time yet
-    long conds;                  // min value for cond(loc) if loc has any hints
+    long conds;                  // min value for cond[loc] if loc has any hints
     long detail;
 
     /*  dflag controls the level of activation of dwarves:
@@ -153,26 +153,27 @@ struct game_t {
     long oldloc;
     long oldlc2;
     long oldobj;
-    bool panic;                  // has player found out he's trapped in the cave?
+    bool panic;                  // has player found out he's trapped?
     long saved;                  // point penalty for saves
     long tally;
     long thresh;
     long trndex;
-    long trnluz;                 // № points lost so far due to number of turns used
-    long turns;                  // how many commands he's given (ignores yes/no)
+    long trnluz;                 // # points lost so far due to turns used
+    long turns;                  // counts commands given (ignores yes/no)
     bool wzdark;                 // whether the loc he's leaving was dark
     char zzword[TOKLEN + 1];     // randomly generated magic word from bird
     bool blooded;                // has player drunk of dragon's blood?
     long abbrev[NLOCATIONS + 1];
     long atloc[NLOCATIONS + 1];
     long dseen[NDWARVES + 1];    // true if dwarf has seen him
-    loc_t dloc[NDWARVES + 1];     // location of dwarves, initially hard-wired in
-    loc_t odloc[NDWARVES + 1];    // prior loc of each dwarf, initially garbage
+    loc_t dloc[NDWARVES + 1];    // location of dwarves, initially hard-wired in
+    loc_t odloc[NDWARVES + 1];   // prior loc of each dwarf, initially garbage
     loc_t fixed[NOBJECTS + 1];
     long link[NOBJECTS * 2 + 1];
     loc_t place[NOBJECTS + 1];
-    long hinted[NHINTS];         // hintlc[i] is how long he's been at LOC with cond bit i
-    long hintlc[NHINTS];         // hinted[i] is true iff hint i has been used.
+    long hinted[NHINTS];         // hinted[i] = true iff hint i has been used.
+    long hintlc[NHINTS];         // hintlc[i] = how long at LOC with cond bit i
+
     long prop[NOBJECTS + 1];
 };