diff options
| author | Martin Rudalics | 2014-08-09 13:12:45 +0200 |
|---|---|---|
| committer | Martin Rudalics | 2014-08-09 13:12:45 +0200 |
| commit | c70e7e185e670b63fd46f6a1f59289816bbab098 (patch) | |
| tree | 073607b2f9e95bb7b6579b7b8b310a7b86d8c543 /src | |
| parent | 5a88c153fcd647a81b2e5f285244bfbf861e1724 (diff) | |
| download | emacs-c70e7e185e670b63fd46f6a1f59289816bbab098.tar.gz emacs-c70e7e185e670b63fd46f6a1f59289816bbab098.zip | |
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
Diffstat (limited to 'src')
| -rw-r--r-- | src/ChangeLog | 8 | ||||
| -rw-r--r-- | 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 @@ | |||
| 1 | 2014-08-09 Martin Rudalics <rudalics@gmx.at> | ||
| 2 | |||
| 3 | * window.c (Fwindow_new_total, Fwindow_new_normal) | ||
| 4 | (Fwindow_new_pixel, Fset_window_new_pixel) | ||
| 5 | (Fset_window_new_total, Fset_window_new_normal): Second attempt | ||
| 6 | to fix the doc-strings of these functions. See: | ||
| 7 | http://lists.gnu.org/archive/html/bug-gnu-emacs/2014-08/msg00287.html | ||
| 8 | |||
| 1 | 2014-08-08 Martin Rudalics <rudalics@gmx.at> | 9 | 2014-08-08 Martin Rudalics <rudalics@gmx.at> |
| 2 | 10 | ||
| 3 | * window.c (Fwindow_valid_p): Fix doc-string (Bug#18194). | 11 | * 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, | |||
| 794 | doc: /* Return the new total size of window WINDOW. | 794 | doc: /* Return the new total size of window WINDOW. |
| 795 | WINDOW must be a valid window and defaults to the selected one. | 795 | WINDOW must be a valid window and defaults to the selected one. |
| 796 | 796 | ||
| 797 | The new total size of WINDOW (see `window-total-size') is that set by | 797 | The new total size of WINDOW is the value set by the last call of |
| 798 | the last call of `set-window-new-total' for WINDOW. */) | 798 | `set-window-new-total' for WINDOW. If it is valid, it will be shortly |
| 799 | installed as WINDOW's total height (see `window-total-height') or total | ||
| 800 | width (see `window-total-width'). */) | ||
| 799 | (Lisp_Object window) | 801 | (Lisp_Object window) |
| 800 | { | 802 | { |
| 801 | return decode_valid_window (window)->new_total; | 803 | return decode_valid_window (window)->new_total; |
| @@ -834,8 +836,9 @@ DEFUN ("window-new-normal", Fwindow_new_normal, Swindow_new_normal, 0, 1, 0, | |||
| 834 | doc: /* Return new normal size of window WINDOW. | 836 | doc: /* Return new normal size of window WINDOW. |
| 835 | WINDOW must be a valid window and defaults to the selected one. | 837 | WINDOW must be a valid window and defaults to the selected one. |
| 836 | 838 | ||
| 837 | The new normal size of WINDOW (see `window-normal-size') is that set by | 839 | The new normal size of WINDOW is the value set by the last call of |
| 838 | the last call of `set-window-new-normal' for WINDOW. */) | 840 | `set-window-new-normal' for WINDOW. If valid, it will be shortly |
| 841 | installed as WINDOW's normal size (see `window-normal-size'). */) | ||
| 839 | (Lisp_Object window) | 842 | (Lisp_Object window) |
| 840 | { | 843 | { |
| 841 | return decode_valid_window (window)->new_normal; | 844 | return decode_valid_window (window)->new_normal; |
| @@ -846,9 +849,9 @@ DEFUN ("window-new-pixel", Fwindow_new_pixel, Swindow_new_pixel, 0, 1, 0, | |||
| 846 | WINDOW must be a valid window and defaults to the selected one. | 849 | WINDOW must be a valid window and defaults to the selected one. |
| 847 | 850 | ||
| 848 | The new pixel size of WINDOW is the value set by the last call of | 851 | The new pixel size of WINDOW is the value set by the last call of |
| 849 | `set-window-new-pixel' for WINDOW. If set correctly, it gets eventually | 852 | `set-window-new-pixel' for WINDOW. If it is valid, it will be shortly |
| 850 | installed by the function `window-resize-apply' and will be returned by | 853 | installed as WINDOW's pixel height (see `window-pixel-height') or pixel |
| 851 | the functions `window-pixel-height' or `window-pixel-width'. */) | 854 | width (see `window-pixel-width'). */) |
| 852 | (Lisp_Object window) | 855 | (Lisp_Object window) |
| 853 | { | 856 | { |
| 854 | return decode_valid_window (window)->new_pixel; | 857 | return decode_valid_window (window)->new_pixel; |
| @@ -3744,9 +3747,9 @@ Return SIZE. | |||
| 3744 | Optional argument ADD non-nil means add SIZE to the new pixel size of | 3747 | Optional argument ADD non-nil means add SIZE to the new pixel size of |
| 3745 | WINDOW and return the sum. | 3748 | WINDOW and return the sum. |
| 3746 | 3749 | ||
| 3747 | The new pixel size of WINDOW is used by `window-resize-apply' and, if | 3750 | The new pixel size of WINDOW, if valid, will be shortly installed as |
| 3748 | that function succeeds, will be subsequently returned by the functions | 3751 | WINDOW's pixel height (see `window-pixel-height') or pixel width (see |
| 3749 | `window-pixel-height' and `window-pixel-width'. | 3752 | `window-pixel-width'). |
| 3750 | 3753 | ||
| 3751 | Note: This function does not operate on any child windows of WINDOW. */) | 3754 | Note: This function does not operate on any child windows of WINDOW. */) |
| 3752 | (Lisp_Object window, Lisp_Object size, Lisp_Object add) | 3755 | (Lisp_Object window, Lisp_Object size, Lisp_Object add) |
| @@ -3772,8 +3775,9 @@ Return SIZE. | |||
| 3772 | Optional argument ADD non-nil means add SIZE to the new total size of | 3775 | Optional argument ADD non-nil means add SIZE to the new total size of |
| 3773 | WINDOW and return the sum. | 3776 | WINDOW and return the sum. |
| 3774 | 3777 | ||
| 3775 | The new total size of WINDOW is used by `window-resize-apply-total' and, | 3778 | The new total size of WINDOW, if valid, will be shortly installed as |
| 3776 | after calling that function, will be returned by `window-total-size'. | 3779 | WINDOW's total height (see `window-total-height') or total width (see |
| 3780 | `window-total-width'). | ||
| 3777 | 3781 | ||
| 3778 | Note: This function does not operate on any child windows of WINDOW. */) | 3782 | Note: This function does not operate on any child windows of WINDOW. */) |
| 3779 | (Lisp_Object window, Lisp_Object size, Lisp_Object add) | 3783 | (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, | |||
| 3794 | WINDOW must be a valid window and defaults to the selected one. | 3798 | WINDOW must be a valid window and defaults to the selected one. |
| 3795 | Return SIZE. | 3799 | Return SIZE. |
| 3796 | 3800 | ||
| 3797 | The new normal size of WINDOW is used by `window-resize-apply' and, if | 3801 | The new normal size of WINDOW, if valid, will be shortly installed as |
| 3798 | that function succeeds, will be subsequently returned by the function | 3802 | WINDOW's normal size (see `window-normal-size'). |
| 3799 | `window-normal-size'. | ||
| 3800 | 3803 | ||
| 3801 | Note: This function does not operate on any child windows of WINDOW. */) | 3804 | Note: This function does not operate on any child windows of WINDOW. */) |
| 3802 | (Lisp_Object window, Lisp_Object size) | 3805 | (Lisp_Object window, Lisp_Object size) |