clojure-lsp.feature.hover

Liking cljdoc? Tell your friends :D

Clojure only.

closing-code
find-docstring
hover
hover-documentation
line-break
opening-code

closing-code^clj

find-docstring^clj

(find-docstring db markdown? uri doc cnt)

Find the doc string for the hovered symbol.

If the symbol's docstring is a string literal, we can process it. If it's reaching into the metadata of another var to get that var's docstring (with the idiom (:doc (meta #'some-var))), use q/find-definition to retrieve the :doc from it and try again.

Limits recurring with q/find-definition to 3 times to avoid potential timeouts.

Find the doc string for the hovered symbol.

If the symbol's docstring is a string literal, we can process it. If it's reaching
into the metadata of another var to get that var's docstring (with the idiom
`(:doc (meta #'some-var)))`, use `q/find-definition` to retrieve the `:doc` from it
and try again.

Limits recurring with `q/find-definition` to 3 times to avoid potential timeouts.

source raw docstring

hover^clj

(hover uri row col components)

(hover uri row col {:keys [db*] :as components} docs-config)

source

hover-documentation^clj

(hover-documentation {sym-ns :ns sym-name :name :keys [doc uri] :as definition}
                     db*
                     {:keys [additional-text-edits?]})

source