Liking cljdoc? Tell your friends :D

clj-info


*info-fn-map*clj

source

*info-output-choice*clj

source

add-info-fn-mapclj

(add-info-fn-map k f)

Convenience function to add additional handlers that present doc-info in different formats across namespaces.

Convenience function to add additional handlers
that present doc-info in different formats across namespaces.
sourceraw docstring

bdoccljmacro

(bdoc w)

Macro that writes html-formatted docs-map info for identifier w. Identifier can be given as string, symbol, or quoted symbol.

Macro that writes html-formatted docs-map info for identifier w.
Identifier can be given as string, symbol, or quoted symbol.
sourceraw docstring

bdoc*clj

(bdoc* w)
(bdoc* w f & f-opts)

Function that writes html-formatted doc-info for identifier w (string) to (default) file f or stdout if f explicit nil.

Function that writes html-formatted doc-info for identifier w (string)
to (default) file f or stdout if f explicit nil.
sourceraw docstring

clj-doccljmacro

(clj-doc)
(clj-doc n)

Prints documentation for a var, namespace, or special form given its name. (generates more info than clojure.core/doc) Name n is string, symbol, or quoted symbol.

Prints documentation for a var, namespace, or special form given
its name. (generates more info than clojure.core/doc)
Name n is string, symbol, or quoted symbol.
sourceraw docstring

clj-doc*clj

(clj-doc*)
(clj-doc* w)
(clj-doc* w f & f-opts)

Function that writes text-formatted documentation for a var, namespace, or special form given its name. (generates more info than clojure.core/doc) Name n is string or (quoted) symbol. Output is written to stdout, or file f.

Function that writes text-formatted documentation for a var,
namespace, or special form given its name. (generates more info
than clojure.core/doc)
Name n is string or (quoted) symbol.
Output is written to stdout, or file f.
sourceraw docstring

clj-info-versionclj

source

edoccljmacro

(edoc w)

Prints documentation for a var or special form given its name. Macro "edoc" is the equivalent of the "clojure.repl/doc" macro, except name-identifier can be a symbol, quoted-symbol or string. (makes it easier to use at the repl, especially for novice users)

Prints documentation for a var or special form given its name.
Macro "edoc" is the equivalent of the "clojure.repl/doc" macro,
except name-identifier can be a symbol, quoted-symbol or string.
(makes it easier to use at the repl, especially for novice users)
sourceraw docstring

edoc*clj

(edoc* name-str-or-sym)

Prints documentation for a var or special form given its name. Function "edoc*" is functional equivalent of "clojure.repl/doc" macro, except that the name-identifier can be a (quoted-)symbol or string. (makes it easier to use at the repl, especially for novice users)

Prints documentation for a var or special form given its name.
Function "edoc*" is functional equivalent of "clojure.repl/doc" macro,
except that the name-identifier can be a (quoted-)symbol or string.
(makes it easier to use at the repl, especially for novice users)
sourceraw docstring

helpcljmacro

(help n)
source

infocljmacro

(info n)

info or help returns documentation and usage information about the name n.

info or help returns documentation and usage information about the name n.
sourceraw docstring

info*clj

(info* n)
sourceraw docstring

tdoccljmacro

(tdoc)
(tdoc n)

Prints documentation for a var, namespace, or special form given its name. (generates more info than clojure.core/doc) Name n is string, symbol, or quoted symbol.

Prints documentation for a var, namespace, or special form given
its name. (generates more info than clojure.core/doc)
Name n is string, symbol, or quoted symbol.
sourceraw docstring

tdoc*clj

(tdoc*)
(tdoc* w)
(tdoc* w f & f-opts)

Function that writes text-formatted documentation for a var, namespace, or special form given its name. (generates more info than clojure.core/doc) Name n is string or (quoted) symbol. Output is written to stdout, or file f.

Function that writes text-formatted documentation for a var,
namespace, or special form given its name. (generates more info
than clojure.core/doc)
Name n is string or (quoted) symbol.
Output is written to stdout, or file f.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close