Set of functions to enhance the runtime available documentation for clojure. Protocol with interfaces to collect doc-info from clojure-entities. Functions to render doc-info in either text or html. More user-friendly "clojure.repl/doc"-like macros/functions to present doc-info in various representations
Set of functions to enhance the runtime available documentation for clojure. Protocol with interfaces to collect doc-info from clojure-entities. Functions to render doc-info in either text or html. More user-friendly "clojure.repl/doc"-like macros/functions to present doc-info in various representations
A protocol for gathering of doc info from objects of different types.
A protocol for gathering of doc info from objects of different types.
(docs-map o)Returns a map with doc info for the object o.
Returns a map with doc info for the object o.
(get-docs-map n)(get-docs-map n opts)Entry function to obtain map with doc-info for object n.
Options (optional map as second argument): :include-clojuredocs - If true, enriches doc-map with ClojureDocs examples, see-alsos, and notes (default: false)
Examples: (get-docs-map 'map) (get-docs-map 'map {:include-clojuredocs true})
Entry function to obtain map with doc-info for object n.
Options (optional map as second argument):
:include-clojuredocs - If true, enriches doc-map with ClojureDocs examples,
see-alsos, and notes (default: false)
Examples:
(get-docs-map 'map)
(get-docs-map 'map {:include-clojuredocs true})(merge-newdocs m n)Merge-in new/alternative docs from clj-info.doc-info-EN/doc-info-map.
Merge-in new/alternative docs from clj-info.doc-info-EN/doc-info-map.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |