[AC21.5] Clarify docstring of where-is-internal

APPROVE COMMIT 21.5 Note that the log was buried in the Xft merge log; I've moved it to a separate log. 2004-12-19 Stephen J. Turnbull <stephen(a)xemacs.org&gt; * keymap.c (Fwhere_is_internal): Rewrite docstring. Index: src/keymap.c =================================================================== RCS file: /pack/xemacscvs/XEmacs/xemacs/src/keymap.c,v retrieving revision 1.60 diff -u -r1.60 keymap.c --- src/keymap.c 22 Nov 2005 10:36:39 -0000 1.60 +++ src/keymap.c 26 Nov 2005 12:09:53 -0000 ＠＠ -3474,17 +3474,20 ＠＠ Return list of keys that invoke DEFINITION in KEYMAPS. KEYMAPS can be either a keymap (meaning search in that keymap and the current global keymap) or a list of keymaps (meaning search in exactly -those keymaps and no others). If KEYMAPS is nil, search in the currently -applicable maps for EVENT-OR-KEYS (this is equivalent to specifying -`(current-keymaps EVENT-OR-KEYS)' as the argument to KEYMAPS). +those keymaps and no others). If optional 3rd arg FIRSTONLY is non-nil, return a vector representing the first key sequence found, rather than a list of all possible key sequences. -If optional 4th arg NOINDIRECT is non-nil, don't follow indirections - to other keymaps or slots. This makes it possible to search for an - indirect definition itself. +Optional 4th argument NOINDIRECT is ignored. (GNU Emacs uses it to allow +searching for an indirect keymap by inhibiting following of indirections to +keymaps or slots, but XEmacs doesn't need it because keymaps are a type.) + +If optional 5th argument EVENT-OR-KEYS is non-nil and KEYMAPS is nil, +search in the currently applicable maps for EVENT-OR-KEYS (this is +equivalent to specifying `(current-keymaps EVENT-OR-KEYS)' as the +argument to KEYMAPS). */ (definition, keymaps, firstonly, UNUSED (noindirect), event_or_keys)) { -- School of Systems and Information Engineering http://turnbull.sk.tsukuba.ac.jp University of Tsukuba Tennodai 1-1-1 Tsukuba 305-8573 JAPAN Ask not how you can "do" free software business; ask what your business can "do for" free software.