procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

(imenu--make-index-alist): Add doc string.

Browse source
This commit is contained in:
Richard M. Stallman 1996-09-30 23:38:43 +00:00
parent aa7c3349af
commit 7e563e040c
1 changed files with 11 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
lisp/imenu.el
View file

@ -447,14 +447,17 @@ This function is called after the function pointed out by
elt)))
alist))
;;;
;;; Find all items in this buffer that should be in the index.
;;; Returns an alist on the form
;;; ((NAME . POSITION) (NAME . POSITION) ...)
;;;
(defun imenu--make-index-alist (&optional noerror)
;; Create a list for this buffer only when needed.
"Create an index-alist for the definitions in the current buffer.
Simple elements in the alist look like (INDEX-NAME . INDEX-POSITION).
Special elements look like (INDEX-NAME FUNCTION ARGUMENTS...).
A nested sub-alist element looks like (INDEX-NAME SUB-ALIST).
The function `imenu--subalist-p' tests an element and returns t
if it is a sub-alist.
There is one simple element with negative POSITION; that's intended
as a way for the user to ask to recalculate the buffer's index alist."
(or (and imenu--index-alist
(or (not imenu-auto-rescan)
(and imenu-auto-rescan
@ -805,7 +808,7 @@ If `imenu-always-use-completion-buffer-p' is non-nil, then the
completion buffer is always used, no matter if the mouse was used or
not.
The returned value is on the form (INDEX-NAME . INDEX-POSITION)."
The returned value is of the form (INDEX-NAME . INDEX-POSITION)."
(let (index-alist
(mouse-triggered (listp last-nonmenu-event))
(result t) )