Commit 94e0933e authored by Chong Yidong's avatar Chong Yidong
Browse files

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.
parent 0e406a72
...@@ -4937,9 +4937,9 @@ do not make the window displaying it the most recently selected ...@@ -4937,9 +4937,9 @@ do not make the window displaying it the most recently selected
one. one.
If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
in the currently selected window; signal an error if that is in the selected window; signal an error if that is
impossible (e.g. if the selected window is minibuffer-only). impossible (e.g. if the selected window is minibuffer-only). If
If non-nil, BUFFER-OR-NAME may be displayed in another window. non-nil, BUFFER-OR-NAME may be displayed in another window.
Return the buffer switched to." Return the buffer switched to."
(interactive (interactive
......
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> 2011-09-24 Glenn Morris <rgm@gnu.org>
* minibuf.c (read_minibuf): Disable line truncation. (Bug#5715) * minibuf.c (read_minibuf): Disable line truncation. (Bug#5715)
......
...@@ -1665,8 +1665,9 @@ DEFUN ("window-prev-buffers", Fwindow_prev_buffers, Swindow_prev_buffers, ...@@ -1665,8 +1665,9 @@ DEFUN ("window-prev-buffers", Fwindow_prev_buffers, Swindow_prev_buffers,
doc: /* Return buffers previously shown in WINDOW. doc: /* Return buffers previously shown in WINDOW.
WINDOW must be a live window and defaults to the selected one. 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, The return value is a list of elements (BUFFER WINDOW-START POS),
window-point> triples where buffer was previously shown in WINDOW. */) 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 window)
{ {
return decode_window (window)->prev_buffers; return decode_window (window)->prev_buffers;
...@@ -1675,11 +1676,11 @@ window-point> triples where buffer was previously shown in WINDOW. */) ...@@ -1675,11 +1676,11 @@ window-point> triples where buffer was previously shown in WINDOW. */)
DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers, DEFUN ("set-window-prev-buffers", Fset_window_prev_buffers,
Sset_window_prev_buffers, 2, 2, 0, Sset_window_prev_buffers, 2, 2, 0,
doc: /* Set WINDOW's previous buffers to PREV-BUFFERS. doc: /* Set WINDOW's previous buffers to PREV-BUFFERS.
WINDOW must be a live window and defaults to the selected one. Return WINDOW must be a live window and defaults to the selected one.
PREV-BUFFERS.
PREV-BUFFERS should be either nil or a list of <buffer, window-start, PREV-BUFFERS should be a list of elements (BUFFER WINDOW-START POS),
window-point> triples where buffer was previously shown in WINDOW. */) 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) (Lisp_Object window, Lisp_Object prev_buffers)
{ {
return decode_window (window)->prev_buffers = 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. */) ...@@ -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, DEFUN ("set-window-next-buffers", Fset_window_next_buffers,
Sset_window_next_buffers, 2, 2, 0, Sset_window_next_buffers, 2, 2, 0,
doc: /* Set WINDOW's next buffers to NEXT-BUFFERS. doc: /* Set WINDOW's next buffers to NEXT-BUFFERS.
WINDOW must be a live window and defaults to the selected one. Return WINDOW must be a live window and defaults to the selected one.
NEXT-BUFFERS. NEXT-BUFFERS should be a list of buffers. */)
NEXT-BUFFERS should be either nil or a list of buffers that have been
recently re-shown in WINDOW. */)
(Lisp_Object window, Lisp_Object next_buffers) (Lisp_Object window, Lisp_Object next_buffers)
{ {
return decode_window (window)->next_buffers = next_buffers; return decode_window (window)->next_buffers = next_buffers;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment