Improved comments for windows library header file.

[plomrogue] / src / misc.h

diff --git a/src/misc.h b/src/misc.h
index 1c1a74903618348ed8c94bdfb0bfdacef2f68715..259a511e124596bc6398c78a15493cfbf609f993 100644 (file)
--- a/src/misc.h
+++ b/src/misc.h
@@ -9,7 +9,7 @@
 
 
 
-#include <stdint.h>    /* for uint16_t, uint32_t */
+#include <stdint.h>    /* for uint8_t, uint16_t, uint32_t */
 #include <stdio.h>     /* for FILE typedef */
 #include "yx_uint16.h" /* for yx_uint16 coordinates */
 struct World;
@@ -54,8 +54,11 @@ extern void save_game(struct World * world);
 
 
 
-/* Toggle display of a window "win". */
-extern void toggle_window(struct WinMeta * win_meta, struct Win * win);
+/* Toggle display of a window "win".
+ *
+ * Return 0 on success, 1 on (ncurses pad/window memory allocation) error.
+ */
+extern uint8_t toggle_window(struct WinMeta * win_meta, struct Win * win);
 
 
 
@@ -70,8 +73,10 @@ extern void scroll_pad(struct WinMeta * win_meta, char dir);
 /* Try to grow or shrink the active window horizontally ("change" = "*"/"_") or
  * vertically ("change = "+"/"-") by one cell size, subject to the limitations
  * provided by the window manager via resize_active_win().
+ *
+ * Return 0 on success, 1 on (ncurses pad/window memory allocation) error.
  */
-extern void growshrink_active_window(struct WinMeta * win_meta, char change);
+extern uint8_t growshrink_active_window(struct WinMeta * win_meta, char change);
 
 
 
@@ -85,11 +90,9 @@ extern struct yx_uint16 find_passable_pos(struct Map * map);
 /* Call some meta game / window management actions dependent on key. If the
  * "quit" action is called, return 1 only instead of doing anything directly.
  */
-extern unsigned char meta_keys(int key, struct World * world,
-                               struct WinMeta * win_meta,
-                               struct Win * win_keys,
-                               struct Win * win_map,
-                               struct Win * win_info,
+extern uint8_t meta_keys(int key, struct World * world,
+                               struct WinMeta * win_meta, struct Win * win_keys,
+                               struct Win * win_map, struct Win * win_info,
                                struct Win * win_log);