aboutsummaryrefslogtreecommitdiffstats
path: root/lisp
diff options
context:
space:
mode:
authorXue Fuqiao2013-10-22 16:07:51 +0800
committerXue Fuqiao2013-10-22 16:07:51 +0800
commitd40a46d75b4d2c8858d2d83b64c0eb8aaf2c8d5f (patch)
tree4443e0af1c37197b96fbcda9a6dda86d2ed48943 /lisp
parenta0f143c90aa823abced50061844eb66704fe9c65 (diff)
downloademacs-d40a46d75b4d2c8858d2d83b64c0eb8aaf2c8d5f.tar.gz
emacs-d40a46d75b4d2c8858d2d83b64c0eb8aaf2c8d5f.zip
Mention the optional ‘display’ argument in doc strings.
* frame.el (display-screens, display-pixel-height) (display-pixel-width, display-mm-width, display-backing-store) (display-save-under, display-planes, display-color-cells) (display-visual-class, display-monitor-attributes-list): Mention the optional ‘display’ argument in doc strings.
Diffstat (limited to 'lisp')
-rw-r--r--lisp/ChangeLog8
-rw-r--r--lisp/frame.el33
2 files changed, 30 insertions, 11 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 9a5e8dccc0c..6e1b8c1373e 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,11 @@
12013-10-22 Xue Fuqiao <xfq.free@gmail.com>
2
3 * frame.el (display-screens, display-pixel-height)
4 (display-pixel-width, display-mm-width, display-backing-store)
5 (display-save-under, display-planes, display-color-cells)
6 (display-visual-class, display-monitor-attributes-list): Mention
7 the optional ‘display’ argument in doc strings.
8
12013-10-22 Michael Gauland <mikelygee@amuri.net> 92013-10-22 Michael Gauland <mikelygee@amuri.net>
2 10
3 * progmodes/ebnf2ps.el (ebnf-prologue): Avoid PS error with some 11 * progmodes/ebnf2ps.el (ebnf-prologue): Avoid PS error with some
diff --git a/lisp/frame.el b/lisp/frame.el
index 70a0189effe..87756f78f1c 100644
--- a/lisp/frame.el
+++ b/lisp/frame.el
@@ -1358,7 +1358,8 @@ frame's display)."
1358(declare-function x-display-screens "xfns.c" (&optional terminal)) 1358(declare-function x-display-screens "xfns.c" (&optional terminal))
1359 1359
1360(defun display-screens (&optional display) 1360(defun display-screens (&optional display)
1361 "Return the number of screens associated with DISPLAY." 1361 "Return the number of screens associated with DISPLAY.
1362If DISPLAY is omitted or nil, it defaults to the selected frame's display."
1362 (let ((frame-type (framep-on-display display))) 1363 (let ((frame-type (framep-on-display display)))
1363 (cond 1364 (cond
1364 ((memq frame-type '(x w32 ns)) 1365 ((memq frame-type '(x w32 ns))
@@ -1374,7 +1375,8 @@ For character terminals, each character counts as a single pixel.
1374For graphical terminals, note that on \"multi-monitor\" setups this 1375For graphical terminals, note that on \"multi-monitor\" setups this
1375refers to the pixel height for all physical monitors associated 1376refers to the pixel height for all physical monitors associated
1376with DISPLAY. To get information for each physical monitor, use 1377with DISPLAY. To get information for each physical monitor, use
1377`display-monitor-attributes-list'." 1378`display-monitor-attributes-list'.
1379If DISPLAY is omitted or nil, it defaults to the selected frame's display."
1378 (let ((frame-type (framep-on-display display))) 1380 (let ((frame-type (framep-on-display display)))
1379 (cond 1381 (cond
1380 ((memq frame-type '(x w32 ns)) 1382 ((memq frame-type '(x w32 ns))
@@ -1390,7 +1392,8 @@ For character terminals, each character counts as a single pixel.
1390For graphical terminals, note that on \"multi-monitor\" setups this 1392For graphical terminals, note that on \"multi-monitor\" setups this
1391refers to the pixel width for all physical monitors associated 1393refers to the pixel width for all physical monitors associated
1392with DISPLAY. To get information for each physical monitor, use 1394with DISPLAY. To get information for each physical monitor, use
1393`display-monitor-attributes-list'." 1395`display-monitor-attributes-list'.
1396If DISPLAY is omitted or nil, it defaults to the selected frame's display."
1394 (let ((frame-type (framep-on-display display))) 1397 (let ((frame-type (framep-on-display display)))
1395 (cond 1398 (cond
1396 ((memq frame-type '(x w32 ns)) 1399 ((memq frame-type '(x w32 ns))
@@ -1425,7 +1428,8 @@ If the information is unavailable, value is nil.
1425For graphical terminals, note that on \"multi-monitor\" setups this 1428For graphical terminals, note that on \"multi-monitor\" setups this
1426refers to the height in millimeters for all physical monitors 1429refers to the height in millimeters for all physical monitors
1427associated with DISPLAY. To get information for each physical 1430associated with DISPLAY. To get information for each physical
1428monitor, use `display-monitor-attributes-list'." 1431monitor, use `display-monitor-attributes-list'.
1432If DISPLAY is omitted or nil, it defaults to the selected frame's display."
1429 (and (memq (framep-on-display display) '(x w32 ns)) 1433 (and (memq (framep-on-display display) '(x w32 ns))
1430 (or (cddr (assoc (or display (frame-parameter nil 'display)) 1434 (or (cddr (assoc (or display (frame-parameter nil 'display))
1431 display-mm-dimensions-alist)) 1435 display-mm-dimensions-alist))
@@ -1441,7 +1445,8 @@ If the information is unavailable, value is nil.
1441For graphical terminals, note that on \"multi-monitor\" setups this 1445For graphical terminals, note that on \"multi-monitor\" setups this
1442refers to the width in millimeters for all physical monitors 1446refers to the width in millimeters for all physical monitors
1443associated with DISPLAY. To get information for each physical 1447associated with DISPLAY. To get information for each physical
1444monitor, use `display-monitor-attributes-list'." 1448monitor, use `display-monitor-attributes-list'.
1449If DISPLAY is omitted or nil, it defaults to the selected frame's display."
1445 (and (memq (framep-on-display display) '(x w32 ns)) 1450 (and (memq (framep-on-display display) '(x w32 ns))
1446 (or (cadr (assoc (or display (frame-parameter nil 'display)) 1451 (or (cadr (assoc (or display (frame-parameter nil 'display))
1447 display-mm-dimensions-alist)) 1452 display-mm-dimensions-alist))
@@ -1455,7 +1460,8 @@ monitor, use `display-monitor-attributes-list'."
1455(defun display-backing-store (&optional display) 1460(defun display-backing-store (&optional display)
1456 "Return the backing store capability of DISPLAY's screen. 1461 "Return the backing store capability of DISPLAY's screen.
1457The value may be `always', `when-mapped', `not-useful', or nil if 1462The value may be `always', `when-mapped', `not-useful', or nil if
1458the question is inapplicable to a certain kind of display." 1463the question is inapplicable to a certain kind of display.
1464If DISPLAY is omitted or nil, it defaults to the selected frame's display."
1459 (let ((frame-type (framep-on-display display))) 1465 (let ((frame-type (framep-on-display display)))
1460 (cond 1466 (cond
1461 ((memq frame-type '(x w32 ns)) 1467 ((memq frame-type '(x w32 ns))
@@ -1466,7 +1472,8 @@ the question is inapplicable to a certain kind of display."
1466(declare-function x-display-save-under "xfns.c" (&optional terminal)) 1472(declare-function x-display-save-under "xfns.c" (&optional terminal))
1467 1473
1468(defun display-save-under (&optional display) 1474(defun display-save-under (&optional display)
1469 "Return non-nil if DISPLAY's screen supports the SaveUnder feature." 1475 "Return non-nil if DISPLAY's screen supports the SaveUnder feature.
1476If DISPLAY is omitted or nil, it defaults to the selected frame's display."
1470 (let ((frame-type (framep-on-display display))) 1477 (let ((frame-type (framep-on-display display)))
1471 (cond 1478 (cond
1472 ((memq frame-type '(x w32 ns)) 1479 ((memq frame-type '(x w32 ns))
@@ -1477,7 +1484,8 @@ the question is inapplicable to a certain kind of display."
1477(declare-function x-display-planes "xfns.c" (&optional terminal)) 1484(declare-function x-display-planes "xfns.c" (&optional terminal))
1478 1485
1479(defun display-planes (&optional display) 1486(defun display-planes (&optional display)
1480 "Return the number of planes supported by DISPLAY." 1487 "Return the number of planes supported by DISPLAY.
1488If DISPLAY is omitted or nil, it defaults to the selected frame's display."
1481 (let ((frame-type (framep-on-display display))) 1489 (let ((frame-type (framep-on-display display)))
1482 (cond 1490 (cond
1483 ((memq frame-type '(x w32 ns)) 1491 ((memq frame-type '(x w32 ns))
@@ -1490,7 +1498,8 @@ the question is inapplicable to a certain kind of display."
1490(declare-function x-display-color-cells "xfns.c" (&optional terminal)) 1498(declare-function x-display-color-cells "xfns.c" (&optional terminal))
1491 1499
1492(defun display-color-cells (&optional display) 1500(defun display-color-cells (&optional display)
1493 "Return the number of color cells supported by DISPLAY." 1501 "Return the number of color cells supported by DISPLAY.
1502If DISPLAY is omitted or nil, it defaults to the selected frame's display."
1494 (let ((frame-type (framep-on-display display))) 1503 (let ((frame-type (framep-on-display display)))
1495 (cond 1504 (cond
1496 ((memq frame-type '(x w32 ns)) 1505 ((memq frame-type '(x w32 ns))
@@ -1505,7 +1514,8 @@ the question is inapplicable to a certain kind of display."
1505(defun display-visual-class (&optional display) 1514(defun display-visual-class (&optional display)
1506 "Return the visual class of DISPLAY. 1515 "Return the visual class of DISPLAY.
1507The value is one of the symbols `static-gray', `gray-scale', 1516The value is one of the symbols `static-gray', `gray-scale',
1508`static-color', `pseudo-color', `true-color', or `direct-color'." 1517`static-color', `pseudo-color', `true-color', or `direct-color'.
1518If DISPLAY is omitted or nil, it defaults to the selected frame's display."
1509 (let ((frame-type (framep-on-display display))) 1519 (let ((frame-type (framep-on-display display)))
1510 (cond 1520 (cond
1511 ((memq frame-type '(x w32 ns)) 1521 ((memq frame-type '(x w32 ns))
@@ -1550,7 +1560,8 @@ is the closest to the frame if the frame does not intersect any
1550physical monitors. Every non-tip frame (including invisible one) 1560physical monitors. Every non-tip frame (including invisible one)
1551in a graphical display is dominated by exactly one physical 1561in a graphical display is dominated by exactly one physical
1552monitor at a time, though it can span multiple (or no) physical 1562monitor at a time, though it can span multiple (or no) physical
1553monitors." 1563monitors.
1564If DISPLAY is omitted or nil, it defaults to the selected frame's display."
1554 (let ((frame-type (framep-on-display display))) 1565 (let ((frame-type (framep-on-display display)))
1555 (cond 1566 (cond
1556 ((eq frame-type 'x) 1567 ((eq frame-type 'x)