Doc tweaks re multi-monitor

* doc/lispref/frames.texi (Multiple Terminals): Copyedits re multiple monitors.

* lisp/frame.el (frame-monitor-attributes, display-monitor-attributes-list):
Doc fixes.

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 1272e740745a21aecf998d64ed954bfe0ff6f06f..673d4d58d2bc8c71c41a0733f12eaabaada3f0e9 100644 (file)
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,7 @@
+2014-10-04  Glenn Morris  <rgm@gnu.org>
+
+       * frames.texi (Multiple Terminals): Copyedits re multiple monitors.
+
 2014-10-03  Martin Rudalics  <rudalics@gmx.at>
 
        * frames.texi (Size Parameters, Size and Position): Mention that

diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi
index 03eba440a093f86748635524d4a2ff57d6761313..afbace3457548e078183c6f78201cac8a14ae970 100644 (file)
--- a/doc/lispref/frames.texi
+++ b/doc/lispref/frames.texi
@@ -314,57 +314,50 @@ on that display (@pxref{Deleting Frames}).
 
 @cindex multi-monitor
   On some ``multi-monitor'' setups, a single X display outputs to more
-than one physical monitor.  @code{display-monitor-attributes-list} and
-@code{frame-monitor-attributes} can be used to obtain information
-about each physical monitor on multi-monitor setups.
+than one physical monitor.  You can use the functions
+@code{display-monitor-attributes-list} and @code{frame-monitor-attributes}
+to obtain information about such setups.
 
 @defun display-monitor-attributes-list &optional display
 This function returns a list of physical monitor attributes on
-@var{display}.  Each element of the list is an association list,
-representing the attributes of each physical monitor.  The first
-element corresponds to the primary monitor.
-
-Attributes for a physical monitor are:
+@var{display}, which defaults to that of the selected frame.
+Each element of the list is an association list, representing the
+attributes of a physical monitor.  The first element corresponds to
+the primary monitor.  The attribute keys and values are:
 
 @table @samp
 @item geometry
-Position and size in pixels in the form of @samp{(X Y WIDTH HEIGHT)}
+Position and size in pixels as @samp{(@var{x} @var{y}
+@var{width} @var{height})}.
 
 @item workarea
-Position and size of the workarea in pixels in the form of @samp{(X Y
-WIDTH HEIGHT)}
+Position and size of the work area in pixels as
+@samp{(@var{x} @var{y} @var{width} @var{height})}.
 
 @item mm-size
-Width and height in millimeters in the form of @samp{(WIDTH HEIGHT)}
+Width and height in millimeters as @samp{(@var{width} @var{height})}
 
 @item frames
-List of frames dominated by the physical monitor
+List of frames that this physical monitor dominates (see below).
 
 @item name
-Name of the physical monitor as a string
+Name of the physical monitor as @var{string}.
 @end table
 
-where X, Y, WIDTH, and HEIGHT are integers.  @samp{name} is optional.
-
-A frame is dominated by a physical monitor when either the
-largest area of the frame resides in the monitor, or the monitor
-is the closest to the frame if the frame does not intersect any
-physical monitors.  Every non-tip frame (including invisible one)
-in a graphical display is dominated by exactly one physical
-monitor at a time, though it can span multiple (or no) physical
-monitors.
+@var{x}, @var{y}, @var{width}, and @var{height} are integers.
+@samp{name} may not be present.
 
-@var{display} defaults to the selected frame's display.
+A frame is @dfn{dominated} by a physical monitor when either the
+largest area of the frame resides in that monitor, or (if the frame
+does not intersect any physical monitors) that monitor is the closest
+to the frame.  Every (non-tooltip) frame (whether visible or not) in a
+graphical display is dominated by exactly one physical monitor at a
+time, though the frame can span multiple (or no) physical monitors.
 @end defun
 
 @defun frame-monitor-attributes &optional frame
 This function returns the attributes of the physical monitor
-dominating @var{frame}, which defaults to the selected frame.
-
-A frame is dominated by a physical monitor when either the
-largest area of the frame resides in the monitor, or the monitor
-is the closest to the frame if the frame does not intersect any
-physical monitors.
+dominating (see above) @var{frame}, which defaults to the selected frame.
 @end defun
 
 @node Frame Parameters

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 736bc591c2a45d2e8ff7f580dfa90e7b1894cb91..5eb29577c9aa3b2f30cb55b71f36282596bb946a 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2014-10-04  Glenn Morris  <rgm@gnu.org>
+
+       * frame.el (frame-monitor-attributes)
+       (display-monitor-attributes-list): Doc fixes.
+
 2014-10-03  Dmitry Gutov  <dgutov@yandex.ru>
 
        * vc/vc-svn.el (vc-svn-ignore-completion-table): Implement.

diff --git a/lisp/frame.el b/lisp/frame.el
index a14b0c2910312598cfec4fe98fe4b775021c299c..f4d7622e662b1f690e3f7326c679df0ef715230a 100644 (file)
--- a/lisp/frame.el
+++ b/lisp/frame.el
@@ -1289,7 +1289,7 @@ bars (top, bottom, or nil)."
 
 (defun frame-monitor-attributes (&optional frame)
   "Return the attributes of the physical monitor dominating FRAME.
-If FRAME is omitted, describe the currently selected frame.
+If FRAME is omitted or nil, describe the currently selected frame.
 
 A frame is dominated by a physical monitor when either the
 largest area of the frame resides in the monitor, or the monitor
@@ -1567,16 +1567,15 @@ If DISPLAY is omitted or nil, it defaults to the selected frame's display."
 
 (defun display-monitor-attributes-list (&optional display)
   "Return a list of physical monitor attributes on DISPLAY.
-Each element of the list represents the attributes of each
-physical monitor.  The first element corresponds to the primary
-monitor.
+If DISPLAY is omitted or nil, it defaults to the selected frame's display.
+Each element of the list represents the attributes of a physical
+monitor.  The first element corresponds to the primary monitor.
 
-Attributes for a physical monitor is represented as an alist of
-attribute keys and values as follows:
+The attributes for a physical monitor are represented as an alist
+of attribute keys and values as follows:
 
- geometry -- Position and size in pixels in the form of
-            (X Y WIDTH HEIGHT)
- workarea -- Position and size of the workarea in pixels in the
+ geometry -- Position and size in pixels in the form of (X Y WIDTH HEIGHT)
+ workarea -- Position and size of the work area in pixels in the
             form of (X Y WIDTH HEIGHT)
  mm-size  -- Width and height in millimeters in the form of
             (WIDTH HEIGHT)
@@ -1589,11 +1588,10 @@ with (*) are optional.
 A frame is dominated by a physical monitor when either the
 largest area of the frame resides in the monitor, or the monitor
 is the closest to the frame if the frame does not intersect any
-physical monitors.  Every non-tip frame (including invisible one)
+physical monitors.  Every (non-tooltip) frame (including invisible ones)
 in a graphical display is dominated by exactly one physical
 monitor at a time, though it can span multiple (or no) physical
-monitors.
-If DISPLAY is omitted or nil, it defaults to the selected frame's display."
+monitors."
   (let ((frame-type (framep-on-display display)))
     (cond
      ((eq frame-type 'x)