codox.utils
Miscellaneous utility functions.
Miscellaneous utility functions.
add-source-pathsclj
(add-source-paths ns-seq root sources)Accepts a sequence of namespaces (generated by
codox.reader/read-namespaces), the project root, and a list of
source directories. The sequence is returned with :path items added
in each public var's entry in the :publics map, which indicate the
path to the source file relative to the repo root.
Accepts a sequence of namespaces (generated by `codox.reader/read-namespaces`), the project root, and a list of source directories. The sequence is returned with :path items added in each public var's entry in the :publics map, which indicate the path to the source file relative to the repo root.
assoc-someclj
(assoc-some m k v)(assoc-some m k v & kvs)Associates a key with a value in a map, if and only if the value is not nil.
Associates a key with a value in a map, if and only if the value is not nil.
public-varsclj
(public-vars namespaces)Return a list of all public var names in a collection of namespaces from one of the reader functions.
Return a list of all public var names in a collection of namespaces from one of the reader functions.
re-escapeclj
(re-escape s)Escape a string so it can be safely placed in a regex.
Escape a string so it can be safely placed in a regex.
search-varsclj
(search-vars namespaces partial-var & [starting-ns])Find the best-matching var given a partial var string, a list of namespaces, and an optional starting namespace.
Find the best-matching var given a partial var string, a list of namespaces, and an optional starting namespace.
summaryclj
(summary s)Return the summary of a docstring. The summary is the first portion of the string, from the first character to the first page break () character OR the first TWO newlines.
Return the summary of a docstring. The summary is the first portion of the string, from the first character to the first page break ( ) character OR the first TWO newlines.
unindentclj
(unindent text)(unindent text indent-size)Unindent a block of text by a specific amount or the smallest common indentation size.
Unindent a block of text by a specific amount or the smallest common indentation size.
update-someclj
(update-some m k f & args)Updates a key in a map with a function, if and only if the return value from the function is not nil.
Updates a key in a map with a function, if and only if the return value from the function is not nil.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close