aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorEli Zaretskii2018-11-19 20:31:49 +0200
committerEli Zaretskii2018-11-19 20:31:49 +0200
commit60457d7ae0cc560115d3e8c83bb308f015e7088d (patch)
tree2cbf61debfdd9978496d28a27a7bcacb6639788e /doc
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 'doc')
-rw-r--r--doc/lispref/windows.texi13
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index 46f106838a5..04689f1c5e2 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -198,12 +198,13 @@ relationships between live windows. The root node of a window tree is
198called the @dfn{root window}. It can be either a live window (if the 198called the @dfn{root window}. It can be either a live window (if the
199frame has just one window), or an internal window. 199frame has just one window), or an internal window.
200 200
201 A minibuffer window (@pxref{Minibuffer Windows}) is not part of its 201 A minibuffer window (@pxref{Minibuffer Windows}) that is not alone
202frame's window tree unless the frame is a minibuffer-only frame. 202on its frame does not have a parent window, so it strictly speaking is
203Nonetheless, most of the functions in this section accept the 203not part of its frame's window tree. Nonetheless, it is a sibling
204minibuffer window as an argument. Also, the function 204window of the frame's root window, and thus can be reached via
205@code{window-tree} described at the end of this section lists the 205@code{window-next-sibling}. Also, the function @code{window-tree}
206minibuffer window alongside the actual window tree. 206described at the end of this section lists the minibuffer window
207alongside the actual window tree.
207 208
208@defun frame-root-window &optional frame-or-window 209@defun frame-root-window &optional frame-or-window
209This function returns the root window for @var{frame-or-window}. The 210This function returns the root window for @var{frame-or-window}. The