aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorEli Zaretskii2018-11-19 20:31:49 +0200
committerEli Zaretskii2018-11-19 20:31:49 +0200
commit60457d7ae0cc560115d3e8c83bb308f015e7088d (patch)
tree2cbf61debfdd9978496d28a27a7bcacb6639788e /src
parentea1a0149825048da940365b79948e71cfc366385 (diff)
downloademacs-60457d7ae0cc560115d3e8c83bb308f015e7088d.tar.gz
emacs-60457d7ae0cc560115d3e8c83bb308f015e7088d.zip
Improve documentation of the window tree
* doc/lispref/windows.texi (Windows and Frames): More accurate wording regarding the relation of a mini-window to its frame's window tree. * src/window.h (struct window): Improve commentary to some fields.
Diffstat (limited to 'src')
-rw-r--r--src/window.h12
1 files changed, 8 insertions, 4 deletions
diff --git a/src/window.h b/src/window.h
index 629283ac40c..c7f525e2704 100644
--- a/src/window.h
+++ b/src/window.h
@@ -93,12 +93,14 @@ struct window
93 /* The frame this window is on. */ 93 /* The frame this window is on. */
94 Lisp_Object frame; 94 Lisp_Object frame;
95 95
96 /* Following (to right or down) and preceding (to left or up) child 96 /* Following (to right or down) and preceding (to left or up)
97 at same level of tree. */ 97 child at same level of tree. Whether this is left/right or
98 up/down is determined by the 'horizontal' flag, see below.
99 A minibuffer window has the frame's root window pointed by 'prev'. */
98 Lisp_Object next; 100 Lisp_Object next;
99 Lisp_Object prev; 101 Lisp_Object prev;
100 102
101 /* The window this one is a child of. */ 103 /* The window this one is a child of. For a minibuffer window: nil. */
102 Lisp_Object parent; 104 Lisp_Object parent;
103 105
104 /* The normal size of the window. These are fractions, but we do 106 /* The normal size of the window. These are fractions, but we do
@@ -113,7 +115,9 @@ struct window
113 Lisp_Object new_normal; 115 Lisp_Object new_normal;
114 Lisp_Object new_pixel; 116 Lisp_Object new_pixel;
115 117
116 /* May be buffer, window, or nil. */ 118 /* For a leaf window: a buffer; for an internal window: a window;
119 for a pseudo-window (such as menu bar or tool bar): nil. It is
120 a buffer for a minibuffer window as well. */
117 Lisp_Object contents; 121 Lisp_Object contents;
118 122
119 /* A marker pointing to where in the text to start displaying. 123 /* A marker pointing to where in the text to start displaying.