diff options
author | Chong Yidong <cyd@stupidchicken.com> | 2011-09-24 18:51:36 -0400 |
---|---|---|
committer | Chong Yidong <cyd@stupidchicken.com> | 2011-09-24 18:51:36 -0400 |
commit | 94e0933e1f0465f5f9a2e9d92e828a1380296bd0 (patch) | |
tree | c5f32e035848010d5c3d4b39422e0cb9c17fce39 | |
parent | 0e406a72ede9743069440dd605abd5fbf12d92c5 (diff) | |
download | emacs-94e0933e1f0465f5f9a2e9d92e828a1380296bd0.tar.gz |
Minor doc fixes for some window functions.
Minor doc fixes for switch-to-buffer, window-prev-buffers,
set-window-prev-buffers, set-window-next-buffers.
-rw-r--r-- | lisp/window.el | 6 | ||||
-rw-r--r-- | src/ChangeLog | 5 | ||||
-rw-r--r-- | src/window.c | 20 |
3 files changed, 17 insertions, 14 deletions
diff --git a/lisp/window.el b/lisp/window.el index 8a72c28f894..512eebcc663 100644 --- a/lisp/window.el +++ b/lisp/window.el @@ -4937,9 +4937,9 @@ do not make the window displaying it the most recently selected one. If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed -in the currently selected window; signal an error if that is -impossible (e.g. if the selected window is minibuffer-only). -If non-nil, BUFFER-OR-NAME may be displayed in another window. +in the selected window; signal an error if that is +impossible (e.g. if the selected window is minibuffer-only). If +non-nil, BUFFER-OR-NAME may be displayed in another window. Return the buffer switched to." (interactive diff --git a/src/ChangeLog b/src/ChangeLog index aaa200054c5..eff52db15a2 100644 --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,8 @@ +2011-09-24 Chong Yidong <cyd@stupidchicken.com> + + * window.c (Fwindow_prev_buffers, Fset_window_prev_buffers) + (Fset_window_next_buffers): Doc fix. + 2011-09-24 Glenn Morris <rgm@gnu.org> * minibuf.c (read_minibuf): Disable line truncation. (Bug#5715) diff --git a/src/window.c b/src/window.c index 39210b91616..ba06779846a 100644 --- a/src/window.c +++ b/src/window.c @@ -1665,8 +1665,9 @@ DEFUN ("window-prev-buffers", Fwindow_prev_buffers, Swindow_prev_buffers, doc: /* Return buffers previously shown in WINDOW. WINDOW must be a live window and defaults to the selected one. -The return value is either nil or a list of <buffer, window-start, -window-point> triples where buffer was previously shown in WINDOW. */) +The return value is a list of elements (BUFFER WINDOW-START POS), +where BUFFER is a buffer, WINDOW-START is the start position of the +window for that buffer, and POS is a window-specific point value. */) (Lisp_Object window) { return decode_window (window)->prev_buffers; @@ -1675,11 +1676,11 @@ window-point> triples where buffer was previously shown in WINDOW. */) DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers, Sset_window_prev_buffers, 2, 2, 0, doc: /* Set WINDOW's previous buffers to PREV-BUFFERS. -WINDOW must be a live window and defaults to the selected one. Return -PREV-BUFFERS. +WINDOW must be a live window and defaults to the selected one. -PREV-BUFFERS should be either nil or a list of <buffer, window-start, -window-point> triples where buffer was previously shown in WINDOW. */) +PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS), +where BUFFER is a buffer, WINDOW-START is the start position of the +window for that buffer, and POS is a window-specific point value. */) (Lisp_Object window, Lisp_Object prev_buffers) { return decode_window (window)->prev_buffers = prev_buffers; @@ -1697,11 +1698,8 @@ WINDOW must be a live window and defaults to the selected one. */) DEFUN ("set-window-next-buffers", Fset_window_next_buffers, Sset_window_next_buffers, 2, 2, 0, doc: /* Set WINDOW's next buffers to NEXT-BUFFERS. -WINDOW must be a live window and defaults to the selected one. Return -NEXT-BUFFERS. - -NEXT-BUFFERS should be either nil or a list of buffers that have been -recently re-shown in WINDOW. */) +WINDOW must be a live window and defaults to the selected one. +NEXT-BUFFERS should be a list of buffers. */) (Lisp_Object window, Lisp_Object next_buffers) { return decode_window (window)->next_buffers = next_buffers; |