codox.reader.pixie
Read raw documentation information from mixed pixie/cljs source directory.
Read raw documentation information from mixed pixie/cljs source directory.
pixie-tst-namespace-returnclj
read-namespacesclj
(read-namespaces)(read-namespaces path)(read-namespaces path & paths)Read Clojure namespaces from a source directory (defaults to "src"), and return a list of maps suitable for documentation purposes.
Any namespace with {:no-doc true} in its metadata will be skipped.
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, :multimethod or :var :added - the library version the var was added in :deprecated - the library version the var was deprecated in
Read Clojure namespaces from a source directory (defaults to
"src"), and return a list of maps suitable for documentation
purposes.
Any namespace with {:no-doc true} in its metadata will be skipped.
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, :multimethod 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