diff options
author | Manuel Uberti <manuel.uberti@inventati.org> | 2020-06-01 15:33:56 +0200 |
---|---|---|
committer | Manuel Uberti <manuel.uberti@inventati.org> | 2020-06-03 11:06:21 +0200 |
commit | 5cf79283d605f3520da434f46fefa82943f2eddd (patch) | |
tree | 256e2a04b101ebcbaf2908918f83e51684b1e308 /helm-imenu.el | |
parent | 130175735fb9c55f9e2a2c1a7d2609d628458f77 (diff) |
Fix documentation
Diffstat (limited to 'helm-imenu.el')
-rw-r--r-- | helm-imenu.el | 33 |
1 files changed, 18 insertions, 15 deletions
diff --git a/helm-imenu.el b/helm-imenu.el index d680c35e..ba1b9cef 100644 --- a/helm-imenu.el +++ b/helm-imenu.el @@ -28,11 +28,11 @@ (defgroup helm-imenu nil - "Imenu related libraries and applications for helm." + "Imenu related libraries and applications for Helm." :group 'helm) (defcustom helm-imenu-delimiter " / " - "Delimit types of candidates and his value in `helm-buffer'." + "Delimit types of candidates and their value in `helm-buffer'." :group 'helm-imenu :type 'string) @@ -44,9 +44,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. -The alist is bidirectional, i.e no need to add '((foo . bar) (bar . foo)) +Allow `helm-imenu-in-all-buffers' searching in these associated +buffers 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) @@ -58,9 +58,10 @@ When nil all candidates are displayed in a single source. NOTE: Each source will have as name \"Imenu <buffer-name>\". `helm-source-imenu-all' will not be set, however it will continue -to be used as a flag for using default as input, if you do not want -this behavior, remove it from `helm-sources-using-default-as-input' -even if not using a single source to display imenu in all buffers." +to be used as a flag for using default as input. If you do not +want this behavior, remove it from +`helm-sources-using-default-as-input' even if not using a single +source to display imenu in all buffers." :type 'boolean :group 'helm-imenu) @@ -69,9 +70,10 @@ even if not using a single source to display imenu in all buffers." ("^\\(Function\\|Functions\\|Defuns\\)$" . font-lock-function-name-face) ("^\\(Types\\|Provides\\|Requires\\|Classes\\|Class\\|Includes\\|Imports\\|Misc\\|Code\\)$" . font-lock-type-face)) "Faces for showing type in helm-imenu. -This is a list of cons cells. The cdr of each cell is a face to be used, -and it can also just be like \\='(:foreground \"yellow\"). -Each car is a regexp match pattern of the imenu type string." +This is a list of cons cells. The cdr of each cell is a face to +be used, and it can also just be like \\='(:foreground +\"yellow\"). Each car is a regexp match pattern of the imenu type +string." :group 'helm-faces :type '(repeat (cons @@ -79,7 +81,7 @@ Each car is a regexp match pattern of the imenu type string." (sexp :tag "Face")))) (defcustom helm-imenu-extra-modes nil - "Extra modes where helm-imenu-in-all-buffers should look into." + "Extra modes where `helm-imenu-in-all-buffers' should look into." :group 'helm-imenu :type '(repeat symbol)) @@ -331,9 +333,10 @@ Each car is a regexp match pattern of the imenu type string." ;;;###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, it is derived i.e `derived-mode-p' -or it have an association in `helm-imenu-all-buffer-assoc'." + "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, it is derived +i.e. `derived-mode-p' or it have an association in +`helm-imenu-all-buffer-assoc'." (interactive) (require 'which-func) (unless helm-imenu-in-all-buffers-separate-sources |