* lisp/imenu.el (imenu--generic-function): Doc fix.

* etc/NEWS: Related markup.
This commit is contained in:
Glenn Morris 2014-02-22 13:20:49 -08:00
parent 123c84f91b
commit 612c3e462e
3 changed files with 9 additions and 2 deletions

View file

@ -704,6 +704,7 @@ the symbol found near point.
*** New option `hi-lock-auto-select-face'. When non-nil, hi-lock commands
will cycle through faces in `hi-lock-face-defaults' without prompting.
---
** New Imenu option `imenu-generic-skip-comments-and-strings'.
** Info

View file

@ -1,5 +1,7 @@
2014-02-22 Glenn Morris <rgm@gnu.org>
* imenu.el (imenu--generic-function): Doc fix.
* register.el (frame-configuration-to-register): Make obsolete.
2014-02-22 Juanma Barranquero <lekktu@gmail.com>

View file

@ -726,8 +726,12 @@ for modes which use `imenu--generic-function'. If it is not set, but
;; so it needs to be careful never to loop!
(defun imenu--generic-function (patterns)
"Return an index alist of the current buffer based on PATTERNS.
PATTERNS should be an alist which has the same form as
`imenu-generic-expression'.
PATTERNS should be an alist with the same form as `imenu-generic-expression'.
If `imenu-generic-skip-comments-and-strings' is non-nil, this ignores
text inside comments and strings.
If `imenu-case-fold-search' is non-nil, this ignores case.
The return value is an alist of the form
(INDEX-NAME . INDEX-POSITION)