summaryrefslogtreecommitdiff
path: root/lisp/window.el
diff options
context:
space:
mode:
authorMartin Rudalics <rudalics@gmx.at>2014-08-10 12:41:28 +0200
committerMartin Rudalics <rudalics@gmx.at>2014-08-10 12:41:28 +0200
commitd5f2feb5818b9da8323bda683983fa7e637c47fd (patch)
tree60f00672682a9f80dff873c6ddb143139b310956 /lisp/window.el
parent02e0530477b2c2fc9a4c5ff05db4ec4555b272dc (diff)
downloademacs-d5f2feb5818b9da8323bda683983fa7e637c47fd.tar.gz
Make doc-string of window-total-size more self-contained.
* window.el (window-total-size): Make doc-string more self-contained.
Diffstat (limited to 'lisp/window.el')
-rw-r--r--lisp/window.el13
1 files changed, 11 insertions, 2 deletions
diff --git a/lisp/window.el b/lisp/window.el
index 09fe52dee88..c73f019870b 100644
--- a/lisp/window.el
+++ b/lisp/window.el
@@ -1117,8 +1117,17 @@ dumping to it."
WINDOW must be a valid window and defaults to the selected one.
If HORIZONTAL is omitted or nil, return the total height of
-WINDOW, in lines, like `window-total-height'. Otherwise return
-the total width, in columns, like `window-total-width'.
+WINDOW, in lines. If WINDOW is live, its total height includes,
+in addition to the height of WINDOW's text, the heights of
+WINDOW's mode and header line and a bottom divider, if any.
+
+If HORIZONTAL is non-nil, return the total width of WINDOW, in
+columns. If WINDOW is live, its total width includes, in
+addition to the width of WINDOW's text, the widths of WINDOW's
+fringes, margins, scroll bars and its right divider, if any.
+
+If WINDOW is internal, return the respective size of the screen
+areas spanned by its children.
Optional argument ROUND is handled as for `window-total-height'
and `window-total-width'."