Improved comments for windows library header file.

[plomrogue] / src / rexit.h

diff --git a/src/rexit.h b/src/rexit.h
index e4c2eb53584476da899e2e87a4e00627da3d928f..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;
 
@@ -34,11 +35,12 @@ extern void exit_game(struct World * world);
 
 
 
-/* If "err" != 0, exit with an error message "msg" and clean up. (For "err",
- * pass the result of functions that return non-zero as an error status and
- * thereby avoid bloating up the code with if-error-conditionals.)
+/* 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(unsigned char err, struct World * world, char * msg);
+extern void exit_err(uint8_t err, struct World * world, char * msg);