summaryrefslogtreecommitdiff
path: root/lisp/imenu.el
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2014-02-22 13:20:49 -0800
committerGlenn Morris <rgm@gnu.org>2014-02-22 13:20:49 -0800
commit612c3e462e40e8ee347276500d8bc7371655e607 (patch)
tree02b44d9503a258c101ba8ea7ab5bcabaae6a2cec /lisp/imenu.el
parent123c84f91bf9206bff013ab7366068b8a16ed687 (diff)
downloademacs-612c3e462e40e8ee347276500d8bc7371655e607.tar.gz
* lisp/imenu.el (imenu--generic-function): Doc fix.
* etc/NEWS: Related markup.
Diffstat (limited to 'lisp/imenu.el')
-rw-r--r--lisp/imenu.el8
1 files changed, 6 insertions, 2 deletions
diff --git a/lisp/imenu.el b/lisp/imenu.el
index 9f11ef45e75..e5f33a5efb9 100644
--- a/lisp/imenu.el
+++ b/lisp/imenu.el
@@ -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)