From c70e7e185e670b63fd46f6a1f59289816bbab098 Mon Sep 17 00:00:00 2001 From: Martin Rudalics Date: Sat, 9 Aug 2014 13:12:45 +0200 Subject: [PATCH] Second attempt to fix some doc-strings in window.c. * window.c (Fwindow_new_total, Fwindow_new_normal) (Fwindow_new_pixel, Fset_window_new_pixel) (Fset_window_new_total, Fset_window_new_normal): Second attempt to fix the doc-strings of these functions. See: http://lists.gnu.org/archive/html/bug-gnu-emacs/2014-08/msg00287.html --- src/ChangeLog | 8 ++++++++ src/window.c | 33 ++++++++++++++++++--------------- 2 files changed, 26 insertions(+), 15 deletions(-) diff --git a/src/ChangeLog b/src/ChangeLog index 6272361196c..6ecce26be14 100644 --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,11 @@ +2014-08-09 Martin Rudalics + + * window.c (Fwindow_new_total, Fwindow_new_normal) + (Fwindow_new_pixel, Fset_window_new_pixel) + (Fset_window_new_total, Fset_window_new_normal): Second attempt + to fix the doc-strings of these functions. See: + http://lists.gnu.org/archive/html/bug-gnu-emacs/2014-08/msg00287.html + 2014-08-08 Martin Rudalics * window.c (Fwindow_valid_p): Fix doc-string (Bug#18194). diff --git a/src/window.c b/src/window.c index 8502e7b022c..3fefd9ce682 100644 --- a/src/window.c +++ b/src/window.c @@ -794,8 +794,10 @@ DEFUN ("window-new-total", Fwindow_new_total, Swindow_new_total, 0, 1, 0, doc: /* Return the new total size of window WINDOW. WINDOW must be a valid window and defaults to the selected one. -The new total size of WINDOW (see `window-total-size') is that set by -the last call of `set-window-new-total' for WINDOW. */) +The new total size of WINDOW is the value set by the last call of +`set-window-new-total' for WINDOW. If it is valid, it will be shortly +installed as WINDOW's total height (see `window-total-height') or total +width (see `window-total-width'). */) (Lisp_Object window) { return decode_valid_window (window)->new_total; @@ -834,8 +836,9 @@ DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0, doc: /* Return new normal size of window WINDOW. WINDOW must be a valid window and defaults to the selected one. -The new normal size of WINDOW (see `window-normal-size') is that set by -the last call of `set-window-new-normal' for WINDOW. */) +The new normal size of WINDOW is the value set by the last call of +`set-window-new-normal' for WINDOW. If valid, it will be shortly +installed as WINDOW's normal size (see `window-normal-size'). */) (Lisp_Object window) { return decode_valid_window (window)->new_normal; @@ -846,9 +849,9 @@ DEFUN ("window-new-pixel", Fwindow_new_pixel, Swindow_new_pixel, 0, 1, 0, WINDOW must be a valid window and defaults to the selected one. The new pixel size of WINDOW is the value set by the last call of -`set-window-new-pixel' for WINDOW. If set correctly, it gets eventually -installed by the function `window-resize-apply' and will be returned by -the functions `window-pixel-height' or `window-pixel-width'. */) +`set-window-new-pixel' for WINDOW. If it is valid, it will be shortly +installed as WINDOW's pixel height (see `window-pixel-height') or pixel +width (see `window-pixel-width'). */) (Lisp_Object window) { return decode_valid_window (window)->new_pixel; @@ -3744,9 +3747,9 @@ Return SIZE. Optional argument ADD non-nil means add SIZE to the new pixel size of WINDOW and return the sum. -The new pixel size of WINDOW is used by `window-resize-apply' and, if -that function succeeds, will be subsequently returned by the functions -`window-pixel-height' and `window-pixel-width'. +The new pixel size of WINDOW, if valid, will be shortly installed as +WINDOW's pixel height (see `window-pixel-height') or pixel width (see +`window-pixel-width'). Note: This function does not operate on any child windows of WINDOW. */) (Lisp_Object window, Lisp_Object size, Lisp_Object add) @@ -3772,8 +3775,9 @@ Return SIZE. Optional argument ADD non-nil means add SIZE to the new total size of WINDOW and return the sum. -The new total size of WINDOW is used by `window-resize-apply-total' and, -after calling that function, will be returned by `window-total-size'. +The new total size of WINDOW, if valid, will be shortly installed as +WINDOW's total height (see `window-total-height') or total width (see +`window-total-width'). Note: This function does not operate on any child windows of WINDOW. */) (Lisp_Object window, Lisp_Object size, Lisp_Object add) @@ -3794,9 +3798,8 @@ DEFUN ("set-window-new-normal", Fset_window_new_normal, Sset_window_new_normal, WINDOW must be a valid window and defaults to the selected one. Return SIZE. -The new normal size of WINDOW is used by `window-resize-apply' and, if -that function succeeds, will be subsequently returned by the function -`window-normal-size'. +The new normal size of WINDOW, if valid, will be shortly installed as +WINDOW's normal size (see `window-normal-size'). Note: This function does not operate on any child windows of WINDOW. */) (Lisp_Object window, Lisp_Object size) -- 2.39.5