Liking cljdoc? Tell your friends :D

orchard.clojuredocs

Find docs from ClojureDocs and retrieve the result as a map.

Find docs from ClojureDocs and retrieve the result as a map.
raw docstring

cacheclj

source

cache-file-nameclj

source

clean-cache!clj

(clean-cache!)

Clean the cached ClojureDocs export file and the in memory cache.

Clean the cached ClojureDocs export file and the in memory cache.
sourceraw docstring

connect-timeoutclj

Timeout value for checking connection. Unit is millisecond.

Timeout value for checking connection. Unit is millisecond.
sourceraw docstring

default-edn-file-urlclj

source

find-docclj

(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.
sourceraw docstring

get-docclj

(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.
sourceraw docstring

load-docs-if-not-loaded!clj

(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.
sourceraw docstring

resolve-and-find-docclj

(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.
sourceraw docstring

see-alsoclj

(see-also var-name)

Get the see-alsos for var-name if any.

Get the see-alsos for `var-name` if any.
sourceraw docstring

test-remote-urlclj

(test-remote-url url)
source

update-cache!clj

(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.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close