Improved explanation of init_win().

[plomrogue] / src / windows.h

diff --git a/src/windows.h b/src/windows.h
index d894fd28e5178f15ce6c42aea82ffb215ddda341..2116b7bef605ae875504ef1e732f089b60f41444 100644 (file)
--- a/src/windows.h
+++ b/src/windows.h
@@ -87,25 +87,25 @@ struct WinMeta
 
 
 
-/* Initialize empty WinMeta "wmeta" on the terminal "screen". Note that
- * emptiness is marked by WinMeta.chain_start=0. Other struct values are also
- * initialized 0, except for the virtual screen (terminal screen height, width =
- * 1) and its terminal-sized frame.
+/* Initialize empty WinMeta "wmeta" on the terminal "screen". (Note that
+ * emptiness is marked by WinMeta.chain_start=0.) Other struct members are also
+ * initialized 0, except for the virtual screen (height = that of the terminal
+ * screen; width = 1) amd its frame sized to the size of the terminal screen.
  */
 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,