Added TODO to windows library.

[plomrogue] / src / windows.h

diff --git a/src/windows.h b/src/windows.h
index 6dd7615759454fa3313de50d339c75b7aa5f2475..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.
  */
@@ -143,7 +145,7 @@ extern uint8_t resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size);
 
 
 
-/* Cycle active window selection forwards (set "dir"="n") or backwards (any
+/* 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.
  */
@@ -151,9 +153,9 @@ 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. Does nothing if no
- * window is active.
+/* 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);