[Emacs-diffs] trunk r116653: Fix some window code related doc-string and info entries.

[Martin Rudalics]

------------------------------------------------------------
revno: 116653
revision-id: address@hidden
parent: address@hidden
committer: martin rudalics <address@hidden>
branch nick: trunk
timestamp: Tue 2014-03-04 11:44:46 +0100
message:
  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.
modified:
  doc/lispref/ChangeLog          changelog-20091113204419-o5vbwnq5f7feedwu-6155
  doc/lispref/windows.texi       
windows.texi-20091113204419-o5vbwnq5f7feedwu-6224
  etc/NEWS                       news-20100311060928-aoit31wvzf25yr1z-1
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/window.el                 window.el-20091113204419-o5vbwnq5f7feedwu-94

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2014-03-03 04:57:26 +0000
+++ b/doc/lispref/ChangeLog     2014-03-04 10:44:46 +0000
@@ -1,3 +1,8 @@
+2014-03-04  Martin Rudalics  <address@hidden>
+
+       * windows.texi (Windows and Frames): Add some missing &optional
+       designators.  Adjust description of window-in-direction.
+
 2014-03-02  Barry O'Reilly  <address@hidden>
 
        * markers.texi (Moving Marker Positions): Clarify guidance about

=== modified file 'doc/lispref/windows.texi'
--- a/doc/lispref/windows.texi  2014-02-27 14:09:26 +0000
+++ b/doc/lispref/windows.texi  2014-03-04 10:44:46 +0000
@@ -137,7 +137,7 @@
 
 Each window belongs to exactly one frame (@pxref{Frames}).
 
address@hidden window-frame window
address@hidden 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 @@
   The following functions can be used to retrieve a child window of an
 internal window, and the siblings of a child window.
 
address@hidden window-top-child window
address@hidden 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
 
address@hidden window-left-child window
address@hidden 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 @@
 @end defun
 
 @cindex window in direction
address@hidden window-in-direction direction &optional window ignore
address@hidden 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 @@
 argument @var{ignore} is address@hidden, a window may be returned even
 if its @code{no-other-window} parameter is address@hidden
 
+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 address@hidden, 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
address@hidden is address@hidden, it returns the minibuffer window even when
+it's not active.  However, if @var{wrap} address@hidden, 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
 

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2014-03-04 08:35:11 +0000
+++ b/etc/NEWS  2014-03-04 10:44:46 +0000
@@ -197,6 +197,12 @@
 ** 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.
 

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-03-04 08:35:11 +0000
+++ b/lisp/ChangeLog    2014-03-04 10:44:46 +0000
@@ -1,3 +1,7 @@
+2014-03-04  Martin Rudalics  <address@hidden>
+
+       * window.el (window-in-direction): Fix doc-string.
+
 2014-03-04  Glenn Morris  <address@hidden>
 
        * emacs-lisp/smie.el (smie-config-guess): Doc fix.

=== modified file 'lisp/window.el'
--- a/lisp/window.el    2014-03-02 12:04:29 +0000
+++ b/lisp/window.el    2014-03-04 10:44:46 +0000
@@ -1817,10 +1817,9 @@
 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