Liking cljdoc? Tell your friends :D

metadoc.reader

Read metadata from given namespace.

Return information extracted from variables' metadata. Currently supported:

  • constants
  • examples and snippets
  • categories
Read metadata from given namespace.

Return information extracted from variables' metadata. Currently supported:

* constants
* examples and snippets
* categories
raw docstring

extract-categoriesclj

(extract-categories ns)

Returns categories and all symbols for each category.

Returns categories and all symbols for each category.
sourceraw docstring

extract-constantsclj

(extract-constants ns)

Extract all constants for given namespace ns.

Returns sorted map with symbol as a key and constant value.

Extract all constants for given namespace `ns`.

Returns sorted map with symbol as a key and constant value.
sourceraw docstring

extract-examplesclj

(extract-examples ns)

Returns all examples for each var. Examples are evaluated.

Returns all examples for each var. Examples are evaluated.
sourceraw docstring

extract-snippetsclj

(extract-snippets ns)

Returns all snippets for given namespace ns.

Returns all snippets for given namespace `ns`.
sourceraw docstring

load-examplesclj

(load-examples)
(load-examples path)

Load examples from metadoc folder.

Call before extracting samples.

Load examples from `metadoc` folder.

Call before extracting samples.
sourceraw docstring

metas-from-public-varsclj

(metas-from-public-vars ns)
(metas-from-public-vars ns k)

Returns metadata for given ns.

When key (or pred) k is provided, filter result and return only metadata containing given key/pred.

Returns metadata for given `ns`.

When key (or pred) `k` is provided, filter result and return only metadata containing given key/pred.
sourceraw docstring

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

× close