Added TODO to windows library.

[plomrogue] / src / windows.h

diff --git a/src/windows.h b/src/windows.h
index 2116b7bef605ae875504ef1e732f089b60f41444..2828e0739421a038aad28885fc3215067a1cf88e 100644 (file)
--- a/src/windows.h
+++ b/src/windows.h
@@ -24,6 +24,8 @@
  * 1 - memory allocation error (of ncurses' pads/windows, or scroll hint texts)
  * 2 - activity forces virtual screen to grow beyond width of 2^16 cells
  *
+ * TODO: Expose less internals to the API.
+ *
  * TODO: Think up a more intuitive window positioning algorithm or at least make
  * the chain that windows are positioned by visible.
  */
@@ -114,7 +116,7 @@ extern struct Win init_win(struct WinMeta * wmeta, char * title,
 
 
 
-/* Append/suspend window "w" to/from chain of visible windows in "wmeta".
+/* Append/suspend window "w" to/from chain of visible windows below "wmeta".
  * Appended windows will become active. Suspended active windows will move the
  * active window selection to their successor in the window chain or, failing
  * that, their predecessor; if no window remains, none will be active.
@@ -136,21 +138,24 @@ extern void reset_pad_offset(struct WinMeta * wmeta, uint16_t new_offset);
 
 /* Apply new size "size" to the active window, but only if it provides for at
  * least one cell width/height and is in height at least one cell smaller than
- * the screen's vertical height (to provide space for the title bar).
+ * the screen's vertical height (to provide space for the title bar). Does
+ * nothing if no window is active.
  */
 extern uint8_t resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size);
 
 
 
-/* Cycle active window selection forwards (set dir="n") or backwards. Wrap
- * around in the windows chain if start / end of it is met.
+/* Cycle active window selection forwards ("dir" == "f") or backwards (any
+ * other "dir"). Wrap around in the windows chain if start / end of it is met.
+ * Does nothing if no window is active.
  */
 extern void cycle_active_win(struct WinMeta * wmeta, char dir);
 
 
 
-/* Move active window forwards (set dir="f") or backwards (set dir="b"). Wrap
- * around in the window chain if start / end of it is met.
+/* Move active window forwards ("dir" == "f") or backwards (any other "dir").
+ * Wrap around in the window chain if start / end of it is met. Does nothing if
+ * no window is active.
  */
 extern uint8_t shift_active_win(struct WinMeta * wmeta, char dir);