mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-19 01:10:57 -08:00
Code Issues Projects Releases Wiki Activity

Clarify docstrings

Browse source 
* src/nsterm.m: Clarified that ns-x-modifier variables require a symbol.
This commit is contained in:
Alan Third 2016-08-29 19:32:40 +01:00
parent 1d0d6d9296
commit bcd2d911f3
1 changed files with 14 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

21
src/nsterm.m
View file

@ -8739,14 +8739,16 @@ syms_of_nsterm (void)
DEFVAR_LISP ("ns-alternate-modifier", ns_alternate_modifier,
"This variable describes the behavior of the alternate or option key.\n\
Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
Set to the symbol control, meta, alt, super, or hyper means it is taken to be\n\
that key.\n\
Set to none means that the alternate / option key is not interpreted by Emacs\n\
at all, allowing it to be used at a lower level for accented character entry.");
ns_alternate_modifier = Qmeta;
DEFVAR_LISP ("ns-right-alternate-modifier", ns_right_alternate_modifier,
"This variable describes the behavior of the right alternate or option key.\n\
Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
Set to the symbol control, meta, alt, super, or hyper means it is taken to be\n\
that key.\n\
Set to left means be the same key as `ns-alternate-modifier'.\n\
Set to none means that the alternate / option key is not interpreted by Emacs\n\
at all, allowing it to be used at a lower level for accented character entry.");
@ -8754,12 +8756,14 @@ at all, allowing it to be used at a lower level for accented character entry.");
DEFVAR_LISP ("ns-command-modifier", ns_command_modifier,
"This variable describes the behavior of the command key.\n\
Set to control, meta, alt, super, or hyper means it is taken to be that key.");
Set to the symbol control, meta, alt, super, or hyper means it is taken to be\n\
that key.");
ns_command_modifier = Qsuper;
DEFVAR_LISP ("ns-right-command-modifier", ns_right_command_modifier,
"This variable describes the behavior of the right command key.\n\
Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
Set to the symbol control, meta, alt, super, or hyper means it is taken to be\n\
that key.\n\
Set to left means be the same key as `ns-command-modifier'.\n\
Set to none means that the command / option key is not interpreted by Emacs\n\
at all, allowing it to be used at a lower level for accented character entry.");
@ -8767,12 +8771,14 @@ at all, allowing it to be used at a lower level for accented character entry.");
DEFVAR_LISP ("ns-control-modifier", ns_control_modifier,
"This variable describes the behavior of the control key.\n\
Set to control, meta, alt, super, or hyper means it is taken to be that key.");
Set to the symbol control, meta, alt, super, or hyper means it is taken to be\n\
that key.");
ns_control_modifier = Qcontrol;
DEFVAR_LISP ("ns-right-control-modifier", ns_right_control_modifier,
"This variable describes the behavior of the right control key.\n\
Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
Set to the symbol control, meta, alt, super, or hyper means it is taken to be\n\
that key.\n\
Set to left means be the same key as `ns-control-modifier'.\n\
Set to none means that the control / option key is not interpreted by Emacs\n\
at all, allowing it to be used at a lower level for accented character entry.");
@ -8780,7 +8786,8 @@ at all, allowing it to be used at a lower level for accented character entry.");
DEFVAR_LISP ("ns-function-modifier", ns_function_modifier,
"This variable describes the behavior of the function key (on laptops).\n\
Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
Set to the symbol control, meta, alt, super, or hyper means it is taken to be\n\
that key.\n\
Set to none means that the function key is not interpreted by Emacs at all,\n\
allowing it to be used at a lower level for accented character entry.");
ns_function_modifier = Qnone;