diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2018-11-19 20:31:49 +0200 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2018-11-19 20:31:49 +0200 |
| commit | 60457d7ae0cc560115d3e8c83bb308f015e7088d (patch) | |
| tree | 2cbf61debfdd9978496d28a27a7bcacb6639788e /src/window.h | |
| parent | ea1a0149825048da940365b79948e71cfc366385 (diff) | |
| download | emacs-60457d7ae0cc560115d3e8c83bb308f015e7088d.tar.gz | |
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/window.h')
| -rw-r--r-- | src/window.h | 12 |
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 /* The frame this window is on. */ Lisp_Object frame; - /* Following (to right or down) and preceding (to left or up) child - at same level of tree. */ + /* Following (to right or down) and preceding (to left or up) + child at same level of tree. Whether this is left/right or + up/down is determined by the 'horizontal' flag, see below. + A minibuffer window has the frame's root window pointed by 'prev'. */ Lisp_Object next; Lisp_Object prev; - /* The window this one is a child of. */ + /* The window this one is a child of. For a minibuffer window: nil. */ Lisp_Object parent; /* The normal size of the window. These are fractions, but we do @@ -113,7 +115,9 @@ struct window Lisp_Object new_normal; Lisp_Object new_pixel; - /* May be buffer, window, or nil. */ + /* For a leaf window: a buffer; for an internal window: a window; + for a pseudo-window (such as menu bar or tool bar): nil. It is + a buffer for a minibuffer window as well. */ Lisp_Object contents; /* A marker pointing to where in the text to start displaying. |