From: Glenn Morris <rgm@gnu.org>
Date: Sat, 22 Feb 2014 21:20:49 +0000 (-0800)
Subject: * lisp/imenu.el (imenu--generic-function): Doc fix.
X-Git-Tag: emacs-24.3.90~173^2^2~12
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=612c3e462e40e8ee347276500d8bc7371655e607;p=emacs.git

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

* etc/NEWS: Related markup.
---

diff --git a/etc/NEWS b/etc/NEWS
index 622a44a02bb..cffe6c8b437 100644
--- 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 47a582750fb..8ebb68622f5 100644
--- 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 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)