diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2018-06-30 12:22:05 +0300 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2018-06-30 12:22:05 +0300 |
| commit | c80f31f591685203162f8fc44fd0f1b98332866a (patch) | |
| tree | 28d7e08406f74eb785ba5bfa614059aea09bbb96 /lisp | |
| parent | 8ebb6830fafcd272bd0d6f7f9d765ef72500ffc5 (diff) | |
| download | emacs-c80f31f591685203162f8fc44fd0f1b98332866a.tar.gz | |
Minor improvements in documentation of imenu.el
* lisp/imenu.el (imenu-generic-skip-comments-and-strings)
(imenu--generic-function): Doc fixes. (Bug#31962)
Diffstat (limited to 'lisp')
| -rw-r--r-- | lisp/imenu.el | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/lisp/imenu.el b/lisp/imenu.el index f56e7b50396..8cf3c768ead 100644 --- a/lisp/imenu.el +++ b/lisp/imenu.el @@ -187,7 +187,9 @@ with name concatenation." (defcustom imenu-generic-skip-comments-and-strings t "When non-nil, ignore text inside comments and strings. -Only affects `imenu--generic-function'." +Only affects `imenu-default-create-index-function' (and any +alternative implementation of `imenu-create-index-function' that +uses `imenu--generic-function')." :type 'boolean :group 'imenu :version "24.4") @@ -738,7 +740,7 @@ 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 with the same form as `imenu-generic-expression'. +PATTERNS should be an alist of the same form as `imenu-generic-expression'. If `imenu-generic-skip-comments-and-strings' is non-nil, this ignores text inside comments and strings. |