diff options
author | Chong Yidong <cyd@gnu.org> | 2012-05-31 14:08:06 +0800 |
---|---|---|
committer | Chong Yidong <cyd@gnu.org> | 2012-05-31 14:08:06 +0800 |
commit | efc00ab16e2890b75d7224434ac43fe944ade4dd (patch) | |
tree | 28c1078ca32b96402cd1a5f618a17b3526143f27 /src/doc.c | |
parent | ba93a18774352c97d6dd73c73141cbff6305581b (diff) | |
parent | dd41169b6cb0105b0766f3d368c657ebafc19cba (diff) | |
download | emacs-efc00ab16e2890b75d7224434ac43fe944ade4dd.tar.gz |
Merge from emacs-24; up to 2012-04-24T21:47:24Z!michael.albinus@gmx.de
Diffstat (limited to 'src/doc.c')
-rw-r--r-- | src/doc.c | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/src/doc.c b/src/doc.c index bec20fb0d94..cd23d9266a2 100644 --- a/src/doc.c +++ b/src/doc.c @@ -705,18 +705,23 @@ the same file name is found in the `doc-directory'. */) DEFUN ("substitute-command-keys", Fsubstitute_command_keys, Ssubstitute_command_keys, 1, 1, 0, doc: /* Substitute key descriptions for command names in STRING. -Substrings of the form \\=\\[COMMAND] replaced by either: a keystroke -sequence that will invoke COMMAND, or "M-x COMMAND" if COMMAND is not -on any keys. -Substrings of the form \\=\\{MAPVAR} are replaced by summaries -\(made by `describe-bindings') of the value of MAPVAR, taken as a keymap. -Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR +Each substring of the form \\=\\[COMMAND] is replaced by either a +keystroke sequence that invokes COMMAND, or "M-x COMMAND" if COMMAND +is not on any keys. + +Each substring of the form \\=\\{MAPVAR} is replaced by a summary of +the value of MAPVAR as a keymap. This summary is similar to the one +produced by `describe-bindings'. The summary ends in two newlines +\(used by the helper function `help-make-xrefs' to find the end of the +summary). + +Each substring of the form \\=\\<MAPVAR> specifies the use of MAPVAR as the keymap for future \\=\\[COMMAND] substrings. \\=\\= quotes the following character and is discarded; thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output. -Returns original STRING if no substitutions were made. Otherwise, -a new string, without any text properties, is returned. */) +Return the original STRING if no substitutions are made. +Otherwise, return a new string, without any text properties. */) (Lisp_Object string) { char *buf; |