home · contact · privacy
Improved comment description of exit_err().
authorChristian Heller <c.heller@plomlompom.de>
Mon, 26 Aug 2013 01:00:39 +0000 (03:00 +0200)
committerChristian Heller <c.heller@plomlompom.de>
Mon, 26 Aug 2013 01:00:39 +0000 (03:00 +0200)
src/rexit.h

index d9d93b238a5fd96b55c0e931a0fe561c12231a85..543a43636de654617383c44d962400ee12e9e3b3 100644 (file)
@@ -35,9 +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 "Details unknown". In any case, also print "err"
- * as the "internal error code". Also print errno if it is non-zero.
+/* 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);