X-Git-Url: https://plomlompom.com/repos/foo.html?a=blobdiff_plain;f=src%2Frexit.h;h=f81d50f36354ba7d3c9c17fa32fe164c4853d163;hb=9462d6eda3804548ce14ee27856b8eb593b2a0e8;hp=f020485f9d3c21c30bae196344a79fdc4a333bed;hpb=6ba18516a602b3d4ad95981887ad9c5eb40a335a;p=plomrogue
diff --git a/src/rexit.h b/src/rexit.h
index f020485..f81d50f 100644
--- a/src/rexit.h
+++ b/src/rexit.h
@@ -35,9 +35,10 @@ 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(uint8_t err, struct World * world, char * msg);