diff options
| author | Luc Teirlinck | 2004-08-09 18:42:04 +0000 |
|---|---|---|
| committer | Luc Teirlinck | 2004-08-09 18:42:04 +0000 |
| commit | 2c0a0e38e968ecf7e394f851c4512ab6d5ecccb6 (patch) | |
| tree | 61a9379e40244315072744b405467ae730c1efd1 /src | |
| parent | 55e0a9c697612b190ec3e33c058c4d361cd11daf (diff) | |
| download | emacs-2c0a0e38e968ecf7e394f851c4512ab6d5ecccb6.tar.gz emacs-2c0a0e38e968ecf7e394f851c4512ab6d5ecccb6.zip | |
(Fmake_keymap, Fmap_keymap, Fwhere_is_internal): Doc fixes.
Diffstat (limited to 'src')
| -rw-r--r-- | src/keymap.c | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/src/keymap.c b/src/keymap.c index 3d4a782b5f8..92cb6902a1e 100644 --- a/src/keymap.c +++ b/src/keymap.c | |||
| @@ -130,10 +130,11 @@ static void silly_event_symbol_error P_ ((Lisp_Object)); | |||
| 130 | 130 | ||
| 131 | DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0, | 131 | DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0, |
| 132 | doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST). | 132 | doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST). |
| 133 | CHARTABLE is a char-table that holds the bindings for the ASCII | 133 | CHARTABLE is a char-table that holds the bindings for all characters |
| 134 | characters. ALIST is an assoc-list which holds bindings for function keys, | 134 | without modifiers. All entries in it are initially nil, meaning |
| 135 | mouse events, and any other things that appear in the input stream. | 135 | "command undefined". ALIST is an assoc-list which holds bindings for |
| 136 | All entries in it are initially nil, meaning "command undefined". | 136 | function keys, mouse events, and any other things that appear in the |
| 137 | input stream. Initially, ALIST is nil. | ||
| 137 | 138 | ||
| 138 | The optional arg STRING supplies a menu name for the keymap | 139 | The optional arg STRING supplies a menu name for the keymap |
| 139 | in case you use it as a menu with `x-popup-menu'. */) | 140 | in case you use it as a menu with `x-popup-menu'. */) |
| @@ -728,7 +729,10 @@ map_keymap_call (key, val, fun, dummy) | |||
| 728 | 729 | ||
| 729 | DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 2, 0, | 730 | DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 2, 0, |
| 730 | doc: /* Call FUNCTION for every binding in KEYMAP. | 731 | doc: /* Call FUNCTION for every binding in KEYMAP. |
| 731 | FUNCTION is called with two arguments: the event and its binding. */) | 732 | FUNCTION is called with two arguments: the event and its binding. |
| 733 | If KEYMAP has a parent, the parent's bindings are included as well. | ||
| 734 | This works recursively: if the parent has itself a parent, then the | ||
| 735 | grandparent's bindings are also included and so on. */) | ||
| 732 | (function, keymap) | 736 | (function, keymap) |
| 733 | Lisp_Object function, keymap; | 737 | Lisp_Object function, keymap; |
| 734 | { | 738 | { |
| @@ -2572,7 +2576,7 @@ where_is_internal (definition, keymaps, firstonly, noindirect, no_remap) | |||
| 2572 | 2576 | ||
| 2573 | DEFUN ("where-is-internal", Fwhere_is_internal, Swhere_is_internal, 1, 5, 0, | 2577 | DEFUN ("where-is-internal", Fwhere_is_internal, Swhere_is_internal, 1, 5, 0, |
| 2574 | doc: /* Return list of keys that invoke DEFINITION. | 2578 | doc: /* Return list of keys that invoke DEFINITION. |
| 2575 | If KEYMAP is non-nil, search only KEYMAP and the global keymap. | 2579 | If KEYMAP is a keymap, search only KEYMAP and the global keymap. |
| 2576 | If KEYMAP is nil, search all the currently active keymaps. | 2580 | If KEYMAP is nil, search all the currently active keymaps. |
| 2577 | If KEYMAP is a list of keymaps, search only those keymaps. | 2581 | If KEYMAP is a list of keymaps, search only those keymaps. |
| 2578 | 2582 | ||
| @@ -2580,8 +2584,8 @@ If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found, | |||
| 2580 | rather than a list of all possible key sequences. | 2584 | rather than a list of all possible key sequences. |
| 2581 | If FIRSTONLY is the symbol `non-ascii', return the first binding found, | 2585 | If FIRSTONLY is the symbol `non-ascii', return the first binding found, |
| 2582 | no matter what it is. | 2586 | no matter what it is. |
| 2583 | If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters, | 2587 | If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters |
| 2584 | and entirely reject menu bindings. | 2588 | \(or their meta variants) and entirely reject menu bindings. |
| 2585 | 2589 | ||
| 2586 | If optional 4th arg NOINDIRECT is non-nil, don't follow indirections | 2590 | If optional 4th arg NOINDIRECT is non-nil, don't follow indirections |
| 2587 | to other keymaps or slots. This makes it possible to search for an | 2591 | to other keymaps or slots. This makes it possible to search for an |