X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fclient%2Fwindows.h;h=97da5f1628e69e846af57c7edebbf5840997b55c;hb=37fb9ef76174a83e27dd27a3250f4be5542e7452;hp=59cf64dec6da821a99207d7ce98b49373d2845c1;hpb=273a2b16c82a26b8f6592cfe08162d5714738108;p=plomrogue

diff --git a/src/client/windows.h b/src/client/windows.h
index 59cf64d..97da5f1 100644
--- a/src/client/windows.h
+++ b/src/client/windows.h
@@ -73,6 +73,10 @@ 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.
  * 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);