Add documentation to :jump setting

This commit is contained in:
Henrik Lissner 2017-07-18 11:57:51 +02:00
parent f6cd37bdde
commit 3bf876f44e
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395

View file

@ -29,7 +29,18 @@ produces an url. Used by `+jump/online'.")
"TODO") "TODO")
(def-setting! :jump (modes &rest plist) (def-setting! :jump (modes &rest plist)
"TODO" "Definies a jump target for major MODES. PLIST accepts the following
properties:
:definition FN
Run when jumping to a symbol's definition.
Used by `+jump/definition'.
:references FN
Run when looking for usage references of a symbol in the current project.
Used by `+jump/references'.
:documentation FN
Run when looking up documentation for a symbol.
Used by `+jump/documentation'."
`(dolist (mode (doom-enlist ,modes)) `(dolist (mode (doom-enlist ,modes))
(push (cons mode (list ,@plist)) +jump-function-alist))) (push (cons mode (list ,@plist)) +jump-function-alist)))