Liking cljdoc? Tell your friends :D

zprint.core


configure-all!

(configure-all!)

Do external configuration regardless of whether or not it already been done, replacing any existing configuration. Returns nil if successful, a vector of errors if not.

Do external configuration regardless of whether or not it already
been done, replacing any existing configuration.  Returns nil if successful,
a vector of errors if not.
sourceraw docstring

czprint

(czprint coll & rest)

Take coll, a Clojure data structure or a string containing Clojure code or data, format it readably, and produce output to stdout containing ANSI escapes to syntax color the output. Optional arguments:

(czprint coll <numeric-width>)
(czprint coll <numeric-width> <options-map>)
(czprint coll <options-map>)

If coll is a string containing Clojure source:

  (czprint coll {:parse-string? true})

(czprint nil :help)    ; for more information
(czprint nil :explain) ; to see the current options-map
Take coll, a Clojure data structure or a string containing Clojure code or
data, format it readably, and produce output to stdout containing ANSI 
escapes to syntax color the output. Optional arguments: 

    (czprint coll <numeric-width>)
    (czprint coll <numeric-width> <options-map>)
    (czprint coll <options-map>)

If coll is a string containing Clojure source:

      (czprint coll {:parse-string? true})

    (czprint nil :help)    ; for more information
    (czprint nil :explain) ; to see the current options-map
sourceraw docstring

czprint-fnmacro

(czprint-fn fn-name & rest)

Given a function name, fn-name, retrieve the source for it, and output to stdout the source formatted in a highly readable manner. Includes ANSI escape sequences to provide syntax coloring, and appends any available specs to the end of the docstring. Optional arguments:

(czprint-fn fn-name <numeric-width>)
(czprint-fn fn-name <numeric-width> <options-map>)
(czprint-fn fn-name <options-map>)

(czprint nil :help)    ; for more information
(czprint nil :explain) ; to see the current options-map
Given a function name, fn-name, retrieve the source for it,
and output to stdout the source formatted in a highly readable
manner. Includes ANSI escape sequences to provide syntax coloring,
and appends any available specs to the end of the docstring.
Optional arguments:

    (czprint-fn fn-name <numeric-width>)
    (czprint-fn fn-name <numeric-width> <options-map>)
    (czprint-fn fn-name <options-map>)

    (czprint nil :help)    ; for more information
    (czprint nil :explain) ; to see the current options-map
sourceraw docstring

czprint-fn-strmacro

(czprint-fn-str fn-name & rest)

Given a function name, fn-name, retrieve the source for it, and return a string with the source formatted in a highly readable manner, including ANSI escape sequences to syntax color the output. Appends any available specs to the end of the docstring. Optional arguments:

(czprint-fn-str fn-name <numeric-width>)
(czprint-fn-str fn-name <numeric-width> <options-map>)
(czprint-fn-str fn-name <options-map>)

(czprint nil :help)    ; for more information
(czprint nil :explain) ; to see the current options-map
Given a function name, fn-name, retrieve the source for it,
and return a string with the source formatted in a highly readable
manner, including ANSI escape sequences to syntax color the output.
Appends any available specs to the end of the docstring. 
Optional arguments:

    (czprint-fn-str fn-name <numeric-width>)
    (czprint-fn-str fn-name <numeric-width> <options-map>)
    (czprint-fn-str fn-name <options-map>)

    (czprint nil :help)    ; for more information
    (czprint nil :explain) ; to see the current options-map
sourceraw docstring

czprint-str

(czprint-str coll & rest)

Take coll, a Clojure data structure or a string containing Clojure code or data, format it readably, and output a str containing ANSI escapes to syntax color the output. Additional optional arguments:

(czprint-str coll <numeric-width>)
(czprint-str coll <numeric-width> <options-map>)
(czprint-str coll <options-map>)

If coll is a string containing Clojure source:

  (czprint-str coll {:parse-string? true})

(czprint nil :help)    ; for more information
(czprint nil :explain) ; to see the current options-map
Take coll, a Clojure data structure or a string containing Clojure code or
data, format it readably, and output a str containing ANSI escapes to 
syntax color the output. Additional optional arguments: 

    (czprint-str coll <numeric-width>)
    (czprint-str coll <numeric-width> <options-map>)
    (czprint-str coll <options-map>)

If coll is a string containing Clojure source:

      (czprint-str coll {:parse-string? true})

    (czprint nil :help)    ; for more information
    (czprint nil :explain) ; to see the current options-map
sourceraw docstring

set-options!

(set-options! new-options)
(set-options! new-options doc-str)

There is an internal options-map containing default values which is configured from ~/.zprintrc when zprint is first used. set-options! is used to alter the internal options-map by specifying individual options-map values that will be merged into the internal options-map.

There is an internal options-map containing default values which is 
configured from ~/.zprintrc when zprint is first used.  set-options! 
is used to alter the internal options-map by specifying individual
options-map values that will be merged into the internal options-map.
sourceraw docstring

zprint

(zprint coll & rest)

Take coll, a Clojure data structure or a string containing Clojure code or data, format it readably, and output to stdout. Additional optional arguments:

(zprint coll <numeric-width>)
(zprint coll <numeric-width> <options-map>)
(zprint coll <options-map>)

If coll is a string containing Clojure source::

  (zprint coll {:parse-string? true})

(zprint nil :help)    ; for more information
(zprint nil :explain) ; to see the current options-map
Take coll, a Clojure data structure or a string containing Clojure code or
data, format it readably, and output to stdout. Additional optional 
arguments: 

    (zprint coll <numeric-width>)
    (zprint coll <numeric-width> <options-map>)
    (zprint coll <options-map>)

If coll is a string containing Clojure source::

      (zprint coll {:parse-string? true})

    (zprint nil :help)    ; for more information
    (zprint nil :explain) ; to see the current options-map
sourceraw docstring

zprint-file

(zprint-file infile file-name outfile)
(zprint-file infile file-name outfile options)

Take an input file infile and an output file outfile, and format every form in the input file with zprint and write it to the output file. infile and outfile are input to slurp and spit, repspectively. ;!zprint directives are recognized in the file. See the File Comment API for information on ;!zprint directives. file-name is a string, and is usually the name of the input file but could be anything to help identify the input file when errors in ;!zprint directives are reported. options is an options-map containing any additional options to be used for this operation, and will be overridden by any options specified in ;!zprint directives.

Take an input file infile and an output file outfile, and format
every form in the input file with zprint and write it to the
output file. infile and outfile are input to slurp and spit,
repspectively. ;!zprint directives are recognized in the file.
See the File Comment API for information on ;!zprint directives.
file-name is a string, and is usually the name of the input file
but could be anything to help identify the input file when errors
in ;!zprint directives are reported.  options is an options-map
containing any additional options to be used for this operation, 
and will be overridden by any options specified in ;!zprint directives.
sourceraw docstring

zprint-file-str

(zprint-file-str file-str zprint-specifier)
(zprint-file-str file-str zprint-specifier new-options)
(zprint-file-str file-str zprint-specifier new-options doc-str)

Take a string, which typically holds the contents of an entire file, but doesn't have to, and format the entire string, outputing a formatted string. It respects white space at the top level, while completely ignoring it within all top level forms (typically defs and function definitions). It allows comments at the top level, as well as in function definitions, and also supports ;!zprint directives at the top level. See File Comment API for information on ;!zprint directives. zprint-specifier is the thing that will be used in messages if errors are detected in ;!zprint directives, so it should identify the file (or other element) to allow the user to find the problem. new-options is an options-map containing options to be used when doing the formatting (and will be overriddden by any options in ;!zprint directives). doc-str is an optional string to be used when setting the new-options into the configuration.

Take a string, which typically holds the contents of an entire
file, but doesn't have to, and format the entire string, outputing
a formatted string.  It respects white space at the top level,
while completely ignoring it within all top level forms (typically
defs and function definitions).  It allows comments at the top
level, as well as in function definitions, and also supports
;!zprint directives at the top level. See File Comment API for
information on ;!zprint directives. zprint-specifier is the thing
that will be used in messages if errors are detected in ;!zprint
directives, so it should identify the file (or other element) to
allow the user to find the problem. new-options is an options-map 
containing options to be used when doing the formatting (and will 
be overriddden by any options in ;!zprint directives).  doc-str is 
an optional string to be used when setting the new-options into the 
configuration.
sourceraw docstring

zprint-fnmacro

(zprint-fn fn-name & rest)

Given a function name, fn-name, retrieve the source for it, and output to stdout the source formatted in a highly readable manner. Appends any available specs to the end of the docstring. Optional arguments:

(zprint-fn fn-name <numeric-width>)
(zprint-fn fn-name <numeric-width> <options-map>)
(zprint-fn fn-name <options-map>)

(zprint nil :help)    ; for more information
(zprint nil :explain) ; to see the current options-map
Given a function name, fn-name, retrieve the source for it,
and output to stdout the source formatted in a highly readable
manner. Appends any available specs to the end of the docstring.
Optional arguments:

    (zprint-fn fn-name <numeric-width>)
    (zprint-fn fn-name <numeric-width> <options-map>)
    (zprint-fn fn-name <options-map>)

    (zprint nil :help)    ; for more information
    (zprint nil :explain) ; to see the current options-map
sourceraw docstring

zprint-fn-strmacro

(zprint-fn-str fn-name & rest)

Given a function name, fn-name, retrieve the source for it, and return a string with the source formatted in a highly readable manner. Appends any available specs to the end of the docstring. Optional arguments:

(zprint-fn-str fn-name <numeric-width>)
(zprint-fn-str fn-name <numeric-width> <options-map>)
(zprint-fn-str fn-name <options-map>)

(zprint nil :help)    ; for more information
(zprint nil :explain) ; to see the current options-map 
Given a function name, fn-name, retrieve the source for it,
and return a string with the source formatted in a highly readable
manner. Appends any available specs to the end of the docstring. 
Optional arguments:

    (zprint-fn-str fn-name <numeric-width>)
    (zprint-fn-str fn-name <numeric-width> <options-map>)
    (zprint-fn-str fn-name <options-map>)

    (zprint nil :help)    ; for more information
    (zprint nil :explain) ; to see the current options-map 
sourceraw docstring

zprint-str

(zprint-str coll & rest)

Take coll, a Clojure data structure or a string containing Clojure code or data, format it readably, and output a str. Additional optional arguments:

(zprint-str coll <numeric-width>)
(zprint-str coll <numeric-width> <options-map>)
(zprint-str coll <options-map>)

If coll is a string containing Clojure source:

  (zprint-str coll {:parse-string? true})

(zprint nil :help)    ; for more information
(zprint nil :explain) ; to see the current options-map
Take coll, a Clojure data structure or a string containing Clojure code or
data, format it readably, and output a str. Additional optional arguments: 

    (zprint-str coll <numeric-width>)
    (zprint-str coll <numeric-width> <options-map>)
    (zprint-str coll <options-map>)

If coll is a string containing Clojure source:

      (zprint-str coll {:parse-string? true})

    (zprint nil :help)    ; for more information
    (zprint nil :explain) ; to see the current options-map
sourceraw docstring

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

× close