Make doc-string of window-total-size more self-contained.

* window.el (window-total-size): Make doc-string more
self-contained.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 91a6e41860f412c5ea6c836ebf10021cee3d7809..cec6e709c2be455264e7d2d292d800d9f7001636 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2014-08-10  Martin Rudalics  <rudalics@gmx.at>
+
+       * window.el (window-total-size): Make doc-string more
+       self-contained.
+
 2014-08-09  Martin Rudalics  <rudalics@gmx.at>
 
        * window.el (display-buffer-below-selected): Restore original

diff --git a/lisp/window.el b/lisp/window.el
index 09fe52dee886e9fa11d6080579464b97017f00fd..c73f019870b45da759ce246bfc1e071074846371 100644 (file)
--- 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'."