diff options
| author | Martin Rudalics | 2008-10-25 10:09:42 +0000 |
|---|---|---|
| committer | Martin Rudalics | 2008-10-25 10:09:42 +0000 |
| commit | 520b29e7aafc134741212a9161e9b3b7d6eca9cd (patch) | |
| tree | e61356af7030392da886f69cda206bb1d44705dc /doc | |
| parent | 09460d9acce90d265e92f6114b3e12b194d76711 (diff) | |
| download | emacs-520b29e7aafc134741212a9161e9b3b7d6eca9cd.tar.gz emacs-520b29e7aafc134741212a9161e9b3b7d6eca9cd.zip | |
(Deleting Windows): Update documentation of delete-windows-on.
(Buffers and Windows): Update documentations of
get-buffer-window and get-buffer-window-list.
(Displaying Buffers): Update documentation of
replace-buffer-in-windows.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/ChangeLog | 7 | ||||
| -rw-r--r-- | doc/lispref/windows.texi | 38 |
2 files changed, 29 insertions, 16 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 29f89ef88c5..f89c6d20afc 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,5 +1,12 @@ | |||
| 1 | 2008-10-25 Martin Rudalics <rudalics@gmx.at> | 1 | 2008-10-25 Martin Rudalics <rudalics@gmx.at> |
| 2 | 2 | ||
| 3 | * windows.texi (Deleting Windows): Update documentation of | ||
| 4 | delete-windows-on. | ||
| 5 | (Buffers and Windows): Update documentations of | ||
| 6 | get-buffer-window and get-buffer-window-list. | ||
| 7 | (Displaying Buffers): Update documentation of | ||
| 8 | replace-buffer-in-windows. | ||
| 9 | |||
| 3 | * buffers.texi (Current Buffer): Reword set-buffer and | 10 | * buffers.texi (Current Buffer): Reword set-buffer and |
| 4 | with-current-buffer documentations. | 11 | with-current-buffer documentations. |
| 5 | (Creating Buffers): Reword documentation of get-buffer-create. | 12 | (Creating Buffers): Reword documentation of get-buffer-create. |
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 8cd8d07db57..89907e489d4 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -388,11 +388,11 @@ deleting the other windows in that frame. If @var{window} is omitted or | |||
| 388 | The return value is @code{nil}. | 388 | The return value is @code{nil}. |
| 389 | @end deffn | 389 | @end deffn |
| 390 | 390 | ||
| 391 | @deffn Command delete-windows-on buffer-or-name &optional frame | 391 | @deffn Command delete-windows-on &optional buffer-or-name frame |
| 392 | This function deletes all windows showing @var{buffer-or-name}. If | 392 | This function deletes all windows showing @var{buffer-or-name}. If |
| 393 | there are no windows showing @var{buffer-or-name}, it does nothing. | 393 | there are no windows showing @var{buffer-or-name}, it does nothing. |
| 394 | @var{buffer-or-name} must be a buffer or the name of an existing | 394 | @var{buffer-or-name} may be a buffer or the name of an existing buffer |
| 395 | buffer. | 395 | and defaults to the current buffer. |
| 396 | 396 | ||
| 397 | @code{delete-windows-on} operates frame by frame. If a frame has | 397 | @code{delete-windows-on} operates frame by frame. If a frame has |
| 398 | several windows showing different buffers, then those showing | 398 | several windows showing different buffers, then those showing |
| @@ -737,14 +737,16 @@ selected window. | |||
| 737 | @end example | 737 | @end example |
| 738 | @end defun | 738 | @end defun |
| 739 | 739 | ||
| 740 | @defun get-buffer-window buffer-or-name &optional all-frames | 740 | @defun get-buffer-window &optional buffer-or-name all-frames |
| 741 | This function returns a window currently displaying | 741 | This function returns a window currently displaying |
| 742 | @var{buffer-or-name}, or @code{nil} if there is none. If there are | 742 | @var{buffer-or-name}, or @code{nil} if there is none. If there are |
| 743 | several such windows, then the function returns the first one in the | 743 | several such windows, then the function returns the first one in the |
| 744 | cyclic ordering of windows, starting from the selected window. | 744 | cyclic ordering of windows, starting from the selected window. |
| 745 | @xref{Cyclic Window Ordering}. | 745 | @xref{Cyclic Window Ordering}. |
| 746 | 746 | ||
| 747 | The argument @var{all-frames} specifies which windows to consider. | 747 | @var{BUFFER-OR-NAME} may be a buffer or a buffer name and defaults to |
| 748 | the current buffer. The argument @var{all-frames} specifies which | ||
| 749 | windows to consider: | ||
| 748 | 750 | ||
| 749 | @itemize @bullet | 751 | @itemize @bullet |
| 750 | @item | 752 | @item |
| @@ -760,13 +762,14 @@ If it is a frame, consider windows on that frame. | |||
| 760 | @end itemize | 762 | @end itemize |
| 761 | @end defun | 763 | @end defun |
| 762 | 764 | ||
| 763 | @defun get-buffer-window-list buffer-or-name &optional minibuf all-frames | 765 | @defun get-buffer-window-list &optional buffer-or-name minibuf all-frames |
| 764 | This function returns a list of all the windows currently displaying | 766 | This function returns a list of all windows currently displaying |
| 765 | @var{buffer-or-name}. | 767 | @var{buffer-or-name}. @var{buffer-or-name} may be a buffer or the name |
| 768 | of an existing buffer and defaults to nil. | ||
| 766 | 769 | ||
| 767 | The two optional arguments work like the optional arguments of | 770 | The two remaining arguments work like the synonymous arguments of |
| 768 | @code{next-window} (@pxref{Cyclic Window Ordering}); they are @emph{not} | 771 | @code{next-window} (@pxref{Cyclic Window Ordering}); they are @emph{not} |
| 769 | like the single optional argument of @code{get-buffer-window}. Perhaps | 772 | like the second optional argument of @code{get-buffer-window}. Perhaps |
| 770 | we should change @code{get-buffer-window} in the future to make it | 773 | we should change @code{get-buffer-window} in the future to make it |
| 771 | compatible with the other functions. | 774 | compatible with the other functions. |
| 772 | @end defun | 775 | @end defun |
| @@ -895,18 +898,21 @@ This function updates the buffer list just like @code{switch-to-buffer} | |||
| 895 | unless @var{norecord} is non-@code{nil}. | 898 | unless @var{norecord} is non-@code{nil}. |
| 896 | @end defun | 899 | @end defun |
| 897 | 900 | ||
| 898 | @deffn Command replace-buffer-in-windows buffer-or-name | 901 | @deffn Command replace-buffer-in-windows &optional buffer-or-name |
| 899 | This function replaces @var{buffer-or-name} in all windows displaying | 902 | This function replaces @var{buffer-or-name} in all windows displaying |
| 900 | it with some other buffer. It uses @code{other-buffer} to choose the | 903 | it with some other buffer. It uses @code{other-buffer} to choose the |
| 901 | other buffer. In the usual applications of this function, you | 904 | other buffer. In the usual applications of this function, you |
| 902 | don't care which other buffer is used; you just want to make sure that | 905 | don't care which other buffer is used; you just want to make sure that |
| 903 | @var{buffer-or-name} is no longer displayed. | 906 | @var{buffer-or-name} is no longer displayed. |
| 904 | 907 | ||
| 905 | If the window displaying @var{buffer-or-name} is dedicated, and | 908 | @var{buffer-or-name} may be a buffer or the name of an existing buffer |
| 906 | is not the only window on its frame, that window is deleted. If that | 909 | and defaults to the current buffer. |
| 907 | window is the only window on its frame and there are other frames left, | 910 | |
| 908 | the window's frame is deleted as well. If there are no other frames left, | 911 | If a window displaying @var{buffer-or-name} is dedicated, and is not the |
| 909 | some other buffer is displayed in that window. | 912 | only window on its frame, that window is deleted. If that window is the |
| 913 | only window on its frame and there are other frames left, the window's | ||
| 914 | frame is deleted too. If there are no other frames left, some other | ||
| 915 | buffer is displayed in that window. | ||
| 910 | 916 | ||
| 911 | This function returns @code{nil}. | 917 | This function returns @code{nil}. |
| 912 | @end deffn | 918 | @end deffn |