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

* etc/NEWS: Related markup.

diff --git a/etc/NEWS b/etc/NEWS
index 622a44a02bb24d50e85cd3e8b08059056b006214..cffe6c8b437551c06f60fb57bbe22ac0c364d363 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -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

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 47a582750fbe0f8cac78ddacd1396feccd191d0c..8ebb68622f5b373323a127805b7829b76a6a71d4 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -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>

diff --git a/lisp/imenu.el b/lisp/imenu.el
index 9f11ef45e7581a22aebfdf96c70d8750006bc4ed..e5f33a5efb956feefcc535b29e56d6bddaf3ae5a 100644 (file)
--- 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)