codox.reader.clojure — org.clojars.karo/codox 0.11.0

Read raw documentation information from Clojure source directory.

core-typed-type clj

(core-typed-type var)

core-typed? clj

(core-typed?)

read-namespaces clj

(read-namespaces)

(read-namespaces paths)

(read-namespaces paths
                 {:keys [exception-handler]
                  :or {exception-handler default-exception-handler}})

Read Clojure 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 ns]) to handle exceptions while reading a namespace

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

try-require clj

(try-require namespace)

typecheck-namespace clj

(typecheck-namespace namespace)

typecheck-var clj

(typecheck-var var)

var->symbol clj

(var->symbol var)