Commit c80f31f5 authored by Eli Zaretskii's avatar Eli Zaretskii
Browse files

Minor improvements in documentation of imenu.el

* lisp/imenu.el (imenu-generic-skip-comments-and-strings)
(imenu--generic-function): Doc fixes.  (Bug#31962)
parent 8ebb6830
...@@ -187,7 +187,9 @@ with name concatenation." ...@@ -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 ...@@ -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.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment