metadoc.reader
Read metadata from given namespace.
Return information extracted from variables’ metadata. Currently supported:
- constants
- examples and snippets
- categories
Categories
Other vars: extract-categories extract-constants extract-examples extract-snippets load-examples metas-from-public-vars
extract-categories
(extract-categories ns)
Returns categories and all symbols for each category.
extract-constants
(extract-constants ns)
Extract all constants for given namespace ns
.
Returns sorted map with symbol as a key and constant value.
extract-examples
(extract-examples ns)
Returns all examples for each var. Examples are evaluated.
load-examples
(load-examples)
(load-examples path)
Load examples from metadoc
folder.
Call before extracting samples.
metas-from-public-vars
(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.