Corrected description of cycle_active_window().

[plomrogue] / src / windows.h

diff --git a/src/windows.h b/src/windows.h
index a13e447c2d98d340d0ed2db562ede8b6d72b60b8..7e666acbca025631716521f41ec5de6f3045114b 100644 (file)
--- a/src/windows.h
+++ b/src/windows.h
@@ -96,16 +96,16 @@ extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta * wmeta);
 
 
 
-/* Create a window below inside "wmeta" titled "title" of "height" and "width"
+/* Create a window as child of "wmeta" titled "title" of "height" and "width"
  * and appointing "func"() to interpret and draw the content stored at "data"
  * if the window is visible.
  *
- * A value for "width" <1 will trigger a fallback to width=1. A "height" <1 or
+ * A value for "width" <1 will trigger a fallback to width=1. A "height" < 1 or
  * larger than the maximum window height possible within the virtual screen will
  * trigger a fallback to the maximum height possible (i.e. pass a "height" of 0
  * to initialize the window to its largest possible height).
  *
- * Other values of the Win struct will be initialized to 0. The window will stay
+ * Other members of the Win struct are initialized to 0. The window will stay
  * invisible until appended to the chain of visible windows via append_win().
  */
 extern struct Win init_win(struct WinMeta * wmeta, char * title,
@@ -114,7 +114,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 +136,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 ("dir" == "b").
+ * 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);