summaryrefslogtreecommitdiff
path: root/helm-imenu.el
diff options
context:
space:
mode:
authorThierry Volpiatto <thierry.volpiatto@gmail.com>2016-05-23 07:26:38 +0200
committerThierry Volpiatto <thierry.volpiatto@gmail.com>2016-05-23 07:26:38 +0200
commit4f39f2d8d4a04f3279d614e87dd3561bd02aca38 (patch)
treedf3b3a110127d9b174459a9567c1a49fe57f730e /helm-imenu.el
parenta6e97c043d44b405656d8a52b981c26aae503737 (diff)
Fix docstrings in helm-imenu.
* helm-imenu.el (helm-imenu-all-buffer-assoc): Do it. (helm-imenu-in-all-buffers): Do it.
Diffstat (limited to 'helm-imenu.el')
-rw-r--r--helm-imenu.el7
1 files changed, 5 insertions, 2 deletions
diff --git a/helm-imenu.el b/helm-imenu.el
index a0fd6bcd..8cb8b8f1 100644
--- a/helm-imenu.el
+++ b/helm-imenu.el
@@ -48,7 +48,9 @@
(defcustom helm-imenu-all-buffer-assoc nil
"Major mode association alist for `helm-imenu-in-all-buffers'.
Allow `helm-imenu-in-all-buffers' searching in these associated buffers
-even if they are not derived from each other."
+even if they are not derived from each other.
+The alist is bidirectional, i.e no need to add '((foo . bar) (bar . foo))
+only '((foo . bar)) is needed."
:type '(alist :key-type symbol :value-type symbol)
:group 'helm-imenu)
@@ -255,7 +257,8 @@ even if they are not derived from each other."
;;;###autoload
(defun helm-imenu-in-all-buffers ()
"Preconfigured helm for fetching imenu entries in all buffers with similar mode as current.
-A mode is similar as current if it is the same or it is derived i.e `derived-mode-p'."
+A mode is similar as current if it is the same, it is derived i.e `derived-mode-p'
+or it have an association in `helm-imenu-all-buffer-assoc'."
(interactive)
(unless helm-source-imenu-all
(setq helm-source-imenu-all