Improved comments for windows library header file.

[plomrogue] / src / rexit.h

diff --git a/src/rexit.h b/src/rexit.h
index ac85577ef6a53f1aacb9186ad8e1fc1d180e8b13..f81d50f36354ba7d3c9c17fa32fe164c4853d163 100644 (file)
--- a/src/rexit.h
+++ b/src/rexit.h
@@ -35,10 +35,10 @@ extern void exit_game(struct World * world);
 
 
 
-/* If "err" != 0, exit with an error message "msg" and clean up. If "msg" is a
- * NULL pointer, return generic error message. (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(uint8_t err, struct World * world, char * msg);