Fix some window code related doc-string and info entries.

* window.el (window-in-direction): Fix doc-string.
* windows.texi (Windows and Frames): Add some missing &optional
designators.  Adjust description of window-in-direction.

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 767c05e49e2b9d2bbc4625bbccc6f869e1457e9d..d50ba585c310b8ffa6b4fd63c2dbac927c69f8f6 100644 (file)
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,8 @@
+2014-03-04  Martin Rudalics  <rudalics@gmx.at>
+
+       * windows.texi (Windows and Frames): Add some missing &optional
+       designators.  Adjust description of window-in-direction.
+
 2014-03-02  Barry O'Reilly  <gundaetiapo@gmail.com>
 
        * markers.texi (Moving Marker Positions): Clarify guidance about

diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index ea7856d6f7f7f3474adffdcefb0ac4f914bbe894..a848128d5978bc5761b8ccaf7316b3f98a61484d 100644 (file)
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -137,7 +137,7 @@ window).
 
 Each window belongs to exactly one frame (@pxref{Frames}).
 
-@defun window-frame window
+@defun window-frame &optional window
 This function returns the frame that the window @var{window} belongs
 to.  If @var{window} is @code{nil}, it defaults to the selected
 window.
@@ -257,14 +257,14 @@ window tree are @var{W2}, @var{W4}, and @var{W5}.
   The following functions can be used to retrieve a child window of an
 internal window, and the siblings of a child window.
 
-@defun window-top-child window
+@defun window-top-child &optional window
 This function returns the topmost child window of @var{window}, if
 @var{window} is an internal window whose children form a vertical
 combination.  For any other type of window, the return value is
 @code{nil}.
 @end defun
 
-@defun window-left-child window
+@defun window-left-child &optional window
 This function returns the leftmost child window of @var{window}, if
 @var{window} is an internal window whose children form a horizontal
 combination.  For any other type of window, the return value is
@@ -322,7 +322,7 @@ the assumption that the frame from our canonical example is selected
 @end defun
 
 @cindex window in direction
-@defun window-in-direction direction &optional window ignore
+@defun window-in-direction direction &optional window ignore sign wrap mini
 This function returns the nearest live window in direction
 @var{direction} as seen from the position of @code{window-point} in
 window @var{window}.  The argument @var{direction} must be one of
@@ -338,6 +338,23 @@ function tries to find another window in the indicated direction whose
 argument @var{ignore} is non-@code{nil}, a window may be returned even
 if its @code{no-other-window} parameter is non-@code{nil}.
 
+If the optional argument @var{sign} is a negative number, it means to
+use the right or bottom edge of @var{window} as reference position
+instead of @code{window-point}.  If @var{sign} is a positive number, it
+means to use the left or top edge of @var{window} as reference position.
+
+If the optional argument @var{wrap} is non-@code{nil}, this means to
+wrap @var{direction} around frame borders.  For example, if @var{window}
+is at the top of the frame and @var{direction} is @code{above}, then
+return the minibuffer window provided the frame has one, and a window at
+the bottom of the frame otherwise.
+
+If the optional argument @var{mini} is @code{nil}, this means to return
+the minibuffer window if and only if it is currently active.  If
+@var{mini} is non-@code{nil}, it returns the minibuffer window even when
+it's not active.  However, if @var{wrap} non-@code{nil}, it always acts
+as if @var{mini} were @code{nil}.
+
 If it doesn't find a suitable window, this function returns @code{nil}.
 @end defun
 

diff --git a/etc/NEWS b/etc/NEWS
index c1342ebfea1df7603e017e0623a0ad799b3edba0..24b3f16556a0b252abb25158f18e1046dc4b4cfd 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -196,6 +196,12 @@ content-type that is found in the new variable `image-format-suffixes'.
 
 ** Frame and window changes
 
++++
+*** The function `window-in-direction' introduced in Emacs 24.1 now
+takes additional arguments for specifiying a reference point, wrapping
+selection around frame borders, and specifying ways to select the
+minibuffer window.
+
 +++
 *** New commands `toggle-frame-fullscreen' and `toggle-frame-maximized',
 bound to <f11> and M-<f10>, respectively.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index a576c69fc071d622d12a07bd18d06fd55a5eb1a2..5cc5291adc8a2a7cf577c19449855cf63ebd5843 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,7 @@
+2014-03-04  Martin Rudalics  <rudalics@gmx.at>
+
+       * window.el (window-in-direction): Fix doc-string.
+
 2014-03-04  Glenn Morris  <rgm@gnu.org>
 
        * emacs-lisp/smie.el (smie-config-guess): Doc fix.

diff --git a/lisp/window.el b/lisp/window.el
index 95672fe87d736da43482ab1cef46df2da1ca0e86..0c42a7906bede8f6d4a5d81222405089bdac48ff 100644 (file)
--- a/lisp/window.el
+++ b/lisp/window.el
@@ -1817,10 +1817,9 @@ or bottom edge of WINDOW as reference position instead of
 top edge of WINDOW as reference position.
 
 Optional argument WRAP non-nil means to wrap DIRECTION around
-frame borders.  This means to return for a WINDOW a the top of
-the frame and DIRECTION `above' to return the minibuffer window
-if the frame has one, and a window at the bottom of the frame
-otherwise.
+frame borders.  This means to return for WINDOW at the top of the
+frame and DIRECTION `above' the minibuffer window if the frame
+has one, and a window at the bottom of the frame otherwise.
 
 Optional argument MINI nil means to return the minibuffer window
 if and only if it is currently active.  MINI non-nil means to