Made sure client is not confused by newlines at the end of config files.

[plomrogue] / src / client / windows.h

diff --git a/src/client/windows.h b/src/client/windows.h
index d8da5be1c71d24298421fa61bd95f67dfb1847e2..97da5f1628e69e846af57c7edebbf5840997b55c 100644 (file)
--- a/src/client/windows.h
+++ b/src/client/windows.h
@@ -70,9 +70,13 @@ extern uint16_t center_offset(uint16_t position,
 /* Get Win of "id". */
 extern struct Win * get_win_by_id(char id);
 
-/* Read/write individual Win (identified by "c") and world.windb.order /
- * world.windb.active from/to "file". Follow writing with "delim" delimiter.
+/* Read/write individual Win (identified by "c") and world.winDB.order /
+ * world.winDB.active from/to "file". Follow writing with "delim" delimiter.
  * Use "line" and "linemax" as expected by try_fgets().
+ *
+ * Note that read_winconf_from_file() returns 1 on success and 0 if it detects
+ * having found the end of the valid interface configuration file by either
+ * hitting a EOF or a newline (so empty newlines at the end of the file are ok).
  */
 extern uint8_t read_winconf_from_file(char * line, uint32_t linemax,
                                       FILE * file);
@@ -84,8 +88,8 @@ extern void write_order_wins_visible_active(FILE * file, char * delim);
 /* Builds virtual sreen from .t_screen's size, fits win's sizes to them.*/
 extern void make_v_screen_and_init_win_sizes();
 
-/* Free all WinDB data. */
-extern void free_windb();
+/* Free all winDB data. */
+extern void free_winDB();
 
 /* The SIGWINCH handler winch_called() merely sets world.winch to 1. This info
  * is used by io_loop() to call reset_windows_on_winch(), which adapts the