Improved comments in windows library header file.

[plomrogue] / src / rexit.h

diff --git a/src/rexit.h b/src/rexit.h
index 8a5444f08b8b06f7336824b4475470c99e045c86..f81d50f36354ba7d3c9c17fa32fe164c4853d163 100644 (file)
--- a/src/rexit.h
+++ b/src/rexit.h
@@ -9,6 +9,7 @@
 
 
 
+#include <stdint.h> /* for uint8_t */
 struct World;
 struct Map;
 
@@ -29,10 +30,17 @@ extern void set_cleanup_flag(enum cleanup_flag flag);
 
 
 
-/* Exit orderly without message or on error with an error message ("msg").
- */
+/* Exit orderly, clean up. */
 extern void exit_game(struct World * world);
-extern void exit_err(struct World * world, char * msg);
+
+
+
+/* If "err" == 0, do nothing. Else, clean up and exit with an error message that
+ * consists, first, of "msg" or (if "msg" is a NULL pointer) a generic "Details
+ * unknown", secondly of "err" as the "internal error code", and thirdly of
+ * errno if it is non-zero.
+ */
+extern void exit_err(uint8_t err, struct World * world, char * msg);