diff options
author | Lute Kamstra <lute@gnu.org> | 2003-10-02 09:45:16 +0000 |
---|---|---|
committer | Lute Kamstra <lute@gnu.org> | 2003-10-02 09:45:16 +0000 |
commit | 61567afa43ca1862e15cdbab37f2c555b198a984 (patch) | |
tree | 2eb2ce013a869d81b0c15fbdf06c05e833631b3a /lisp/imenu.el | |
parent | cfdd394e98bc7870f7b4cc8224e9f719c297dc2e (diff) | |
download | emacs-61567afa43ca1862e15cdbab37f2c555b198a984.tar.gz |
(imenu--generic-function): Docstring fix.
Diffstat (limited to 'lisp/imenu.el')
-rw-r--r-- | lisp/imenu.el | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/lisp/imenu.el b/lisp/imenu.el index 63da70f0923..42f50fba3a4 100644 --- a/lisp/imenu.el +++ b/lisp/imenu.el @@ -751,6 +751,9 @@ for modes which use `imenu--generic-function'. If it is not set, but PATTERNS is an alist with elements that look like this: (MENU-TITLE REGEXP INDEX). +or like this: + (MENU-TITLE REGEXP INDEX FUNCTION ARGUMENTS...) +with zero or more ARGUMENTS. MENU-TITLE is a string used as the title for the submenu or nil if the entries are not nested. @@ -766,9 +769,13 @@ function, variable or type) that is to appear in the menu. See `lisp-imenu-generic-expression' for an example of PATTERNS. Returns an index of the current buffer as an alist. The elements in -the alist look like: (INDEX-NAME . INDEX-POSITION). They may also be -nested index lists like (INDEX-NAME . INDEX-ALIST) depending on -PATTERNS." +the alist look like: + (INDEX-NAME . INDEX-POSITION) +or like: + (INDEX-NAME INDEX-POSITION FUNCTION ARGUMENTS...) +They may also be nested index alists like: + (INDEX-NAME . INDEX-ALIST) +depending on PATTERNS." (let ((index-alist (list 'dummy)) prev-pos beg |