Applied new formatting and documentation rules to draw_wins library.

[plomrogue] / src / draw_wins.h

diff --git a/src/draw_wins.h b/src/draw_wins.h
index 2013efd4f4893b718ee510d4ea5ab145314da5c0..c7950b829b3ee476339be20161335af7df79a72c 100644 (file)
--- a/src/draw_wins.h
+++ b/src/draw_wins.h
@@ -1,15 +1,48 @@
+/* draw_wins.h
+ *
+ * Routnes for drawing the game's windows' contents.
+ */
+
 #ifndef DRAW_WINS_H
 #define DRAW_WINS_H
 
-#include <stdint.h>
 
+
+#include <stdint.h> /* for uint16_t */
 struct Win;
 
-extern void draw_with_linebreaks (struct Win *, char *, uint16_t);
-extern void draw_text_from_bottom (struct Win *, char *);
-extern void draw_log_win (struct Win *);
-extern void draw_map_win (struct Win *);
-extern void draw_info_win (struct Win *);
-extern void draw_keys_win (struct Win *);
+
+/* Write "text" into window "win". Start on row "start_y". Fill unused rows with
+ * whitespace.
+ */
+extern void draw_with_linebreaks(struct Win * win, char * text,
+                                 uint16_t start_y);
+
+
+
+/* Write "text" not starting from the top but from the bottom of "win". */
+extern void draw_text_from_bottom(struct Win * win, char * text);
+
+
+
+/* Write game log text into "win" from bottom to top. */
+extern void draw_log_win(struct Win * win);
+
+
+
+/* Draw game map and actors/objects on it into "win". Respect scroll offset. */
+extern void draw_map_win (struct Win * win);
+
+
+
+/* Draw into "win" the game / player status infos. */
+extern void draw_info_win (struct Win * win);
+
+
+
+/* Draw keybindings selection/manipulation menu. */
+extern void draw_keys_win (struct Win * win);
+
+
 
 #endif