aboutsummaryrefslogtreecommitdiffstats
path: root/src/frame.c
diff options
context:
space:
mode:
authorEli Zaretskii2015-12-11 10:46:18 +0200
committerEli Zaretskii2015-12-11 10:46:18 +0200
commit1db9d8bd0fb41bda3cc8027ec0cf27aade71b400 (patch)
treefee1506360acc80212fa24fd2add5e93b94c480b /src/frame.c
parentb3277c7d3913ccedfac36c27ab657901e4f131b4 (diff)
downloademacs-1db9d8bd0fb41bda3cc8027ec0cf27aade71b400.tar.gz
emacs-1db9d8bd0fb41bda3cc8027ec0cf27aade71b400.zip
Clarify documentation of 'modify-frame-parameters'
* doc/lispref/frames.texi (Parameter Access): Clarify what "ignored PARMs" mean for 'modify-frame-parameters'. * src/frame.c (Fmodify_frame_parameters): Clarify what "ignored PARMs" mean for this function. (Bug#22104)
Diffstat (limited to 'src/frame.c')
-rw-r--r--src/frame.c11
1 files changed, 7 insertions, 4 deletions
diff --git a/src/frame.c b/src/frame.c
index c388986e351..4897052e1f9 100644
--- a/src/frame.c
+++ b/src/frame.c
@@ -2641,13 +2641,16 @@ If FRAME is nil, describe the currently selected frame. */)
2641 2641
2642DEFUN ("modify-frame-parameters", Fmodify_frame_parameters, 2642DEFUN ("modify-frame-parameters", Fmodify_frame_parameters,
2643 Smodify_frame_parameters, 2, 2, 0, 2643 Smodify_frame_parameters, 2, 2, 0,
2644 doc: /* Modify the parameters of frame FRAME according to ALIST. 2644 doc: /* Modify FRAME according to new values of its parameters in ALIST.
2645If FRAME is nil, it defaults to the selected frame. 2645If FRAME is nil, it defaults to the selected frame.
2646ALIST is an alist of parameters to change and their new values. 2646ALIST is an alist of parameters to change and their new values.
2647Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol. 2647Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol.
2648The meaningful PARMs depend on the kind of frame. 2648Which PARMs are meaningful depends on the kind of frame.
2649Undefined PARMs are ignored, but stored in the frame's parameter list 2649The meaningful parameters are acted upon, i.e. the frame is changed
2650so that `frame-parameters' will return them. 2650according to their new values, and are also stored in the frame's
2651parameter list so that `frame-parameters' will return them.
2652PARMs that are not meaningful are still stored in the frame's parameter
2653list, but are otherwise ignored.
2651 2654
2652The value of frame parameter FOO can also be accessed 2655The value of frame parameter FOO can also be accessed
2653as a frame-local binding for the variable FOO, if you have 2656as a frame-local binding for the variable FOO, if you have