codox.reader.clojurescript
Read raw documentation information from ClojureScript source directory.
Read raw documentation information from ClojureScript source directory.
read-namespacesclj
(read-namespaces)(read-namespaces paths)(read-namespaces paths
{:keys [exception-handler]
:or {exception-handler default-exception-handler}})Read ClojureScript namespaces from a set of source directories (defaults to ["src"]), and return a list of maps suitable for documentation purposes.
Supported options using the second argument: :exception-handler - function (fn [ex file]) to handle exceptions while reading a namespace
The keys in the maps are: :name - the name of the namespace :doc - the doc-string on the namespace :author - the author of the namespace :publics :name - the name of a public function, macro, or value :file - the file the var was declared in :line - the line at which the var was declared :arglists - the arguments the function or macro takes :doc - the doc-string of the var :type - one of :macro, :protocol or :var :added - the library version the var was added in :deprecated - the library version the var was deprecated in
Read ClojureScript namespaces from a set of source directories
(defaults to ["src"]), and return a list of maps suitable for
documentation purposes.
Supported options using the second argument:
:exception-handler - function (fn [ex file]) to handle exceptions
while reading a namespace
The keys in the maps are:
:name - the name of the namespace
:doc - the doc-string on the namespace
:author - the author of the namespace
:publics
:name - the name of a public function, macro, or value
:file - the file the var was declared in
:line - the line at which the var was declared
:arglists - the arguments the function or macro takes
:doc - the doc-string of the var
:type - one of :macro, :protocol or :var
:added - the library version the var was added in
:deprecated - the library version the var was deprecated incljdoc is a website building & hosting documentation for Clojure/Script libraries
× close