Find docs from ClojureDocs and retrieve the result as a map.
Find docs from ClojureDocs and retrieve the result as a map.
(clean-cache!)
Clean the cached ClojureDocs export file and the in memory cache.
Clean the cached ClojureDocs export file and the in memory cache.
Timeout value for checking connection. Unit is millisecond.
Timeout value for checking connection. Unit is millisecond.
(find-doc ns sym)
Find documentation matching ns
and sym
from the cached documentation.
Bundled documentation will be used when there is no cached documentation.
Return nil if there is no matching documentation.
Find documentation matching `ns` and `sym` from the cached documentation. Bundled documentation will be used when there is no cached documentation. Return nil if there is no matching documentation.
(get-doc var-name)
Get data for var-name
.
Bundled documentation will be used when there is no cached documentation.
Get data for `var-name`. Bundled documentation will be used when there is no cached documentation.
(load-docs-if-not-loaded!)
Load exported docs from bundled or cached file when no docs are loaded. The Cached file take priority.
Load exported docs from bundled or cached file when no docs are loaded. The Cached file take priority.
(resolve-and-find-doc ns sym)
Resolve sym
in the context of ns
and look up the documentation
for the resulting var.
Resolve `sym` in the context of `ns` and look up the documentation for the resulting var.
(see-also var-name)
Get the see-alsos for var-name
if any.
Get the see-alsos for `var-name` if any.
(update-cache!)
(update-cache! export-edn-url)
Load exported docs file from ClojureDocs, and store it as a cache.
A EDN format file is expected to the export-edn-url
argument.
If export-edn-url
is omitted, default-edn-file-url
is used.
If export-edn-url
is not accessible, IOException
is thrown.
If export-edn-url
is not a URL for remote host, IllegalArgumentException
is thrown.
Load exported docs file from ClojureDocs, and store it as a cache. A EDN format file is expected to the `export-edn-url` argument. If `export-edn-url` is omitted, `default-edn-file-url` is used. If `export-edn-url` is not accessible, `IOException` is thrown. If `export-edn-url` is not a URL for remote host, `IllegalArgumentException` is thrown.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close