Generate documentation for defnz functions from their inspection
metadata. Pure functions turn a Var (or its metadata) into a markdown
string; emit-namespace-to-file! is the shell writer.
(clj-zig.doc/emit-var #'add)
;; => "### add\n\n`[x :i64 y :i64 :ret :i64]`\n\nAdds two integers.\n"
(clj-zig.doc/emit-namespace 'my.app)
;; => full markdown for every defnz in the namespace
Generate documentation for `defnz` functions from their inspection
metadata. Pure functions turn a Var (or its metadata) into a markdown
string; `emit-namespace-to-file!` is the shell writer.
(clj-zig.doc/emit-var #'add)
;; => "### add\n\n`[x :i64 y :i64 :ret :i64]`\n\nAdds two integers.\n"
(clj-zig.doc/emit-namespace 'my.app)
;; => full markdown for every defnz in the namespace(emit-namespace ns-sym)Generate markdown documentation for every defnz Var in ns-sym.
Vars are sorted alphabetically by name.
Generate markdown documentation for every `defnz` Var in `ns-sym`. Vars are sorted alphabetically by name.
(emit-namespace-to-file! ns-sym path)Write the documentation for ns-sym to path as markdown.
Write the documentation for `ns-sym` to `path` as markdown.
(emit-var the-var)Generate a markdown section documenting one defnz Var. Includes the
function name, docstring, signature table, and return type. Returns nil
for a non-defnz Var (no :clj-zig/info metadata).
Generate a markdown section documenting one `defnz` Var. Includes the function name, docstring, signature table, and return type. Returns nil for a non-defnz Var (no `:clj-zig/info` metadata).
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 |