changeset 52733:9cb896b7b7e2

(imenu--generic-function): Docstring fix.
author Lute Kamstra <lute@gnu.org>
date Thu, 02 Oct 2003 09:44:50 +0000
parents f282b28429c3
children 9f8ba6896b9c
files lisp/imenu.el
diffstat 1 files changed, 10 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/imenu.el	Thu Oct 02 09:44:01 2003 +0000
+++ b/lisp/imenu.el	Thu Oct 02 09:44:50 2003 +0000
@@ -751,6 +751,9 @@
 
 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 @@
 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