procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor improvements in documentation of imenu.el

Browse source 
* lisp/imenu.el (imenu-generic-skip-comments-and-strings)
(imenu--generic-function): Doc fixes.  (Bug#31962)
This commit is contained in:
Eli Zaretskii 2018-06-30 12:22:05 +03:00
parent 8ebb6830fa
commit c80f31f591
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
lisp/imenu.el
View file

@ -187,7 +187,9 @@ with name concatenation."
(defcustom imenu-generic-skip-comments-and-strings t (defcustom imenu-generic-skip-comments-and-strings t
"When non-nil, ignore text inside comments and strings. "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 :type 'boolean
:group 'imenu :group 'imenu
:version "24.4") :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! ;; so it needs to be careful never to loop!
(defun imenu--generic-function (patterns) (defun imenu--generic-function (patterns)
"Return an index alist of the current buffer based on 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 If `imenu-generic-skip-comments-and-strings' is non-nil, this ignores
text inside comments and strings. text inside comments and strings.