From e61d6780abaff6a750f56a75d6d68ebace0181df Mon Sep 17 00:00:00 2001 From: Tom Faulhaber Date: Fri, 7 Aug 2009 23:37:28 -0700 Subject: Updated documentation for commit 6dd2205627cd524894b1175da20ce9c5ac65aef7 --- pprint-api.html | 70 ++++++++++++++++++++++++++++----------------------------- 1 file changed, 35 insertions(+), 35 deletions(-) (limited to 'pprint-api.html') diff --git a/pprint-api.html b/pprint-api.html index acd71218..d8a74926 100644 --- a/pprint-api.html +++ b/pprint-api.html @@ -34,7 +34,7 @@ namespace. API Index
Namespaces: @@ -165,28 +165,28 @@ Complete documentation is available on the wiki at the contrib google code site. 
Usage: (*code-dispatch* object)
 
The pretty print dispatch function for pretty printing Clojure code.
- Source + Source

*print-base*

var

   
The base to use for printing integers and rationals.

-  Source
+  Source
 

   

   
*print-circle*

   var

   

   
Mark circular structures (N.B. This is not yet used)

-  Source
+  Source
 

   

   
*print-lines*

   var

   

   
Maximum number of lines to print in a pretty print instance (N.B. This is not yet used)

-  Source
+  Source
 

   

   
*print-miser-width*

@@ -195,7 +195,7 @@ Complete documentation is available on the wiki at the contrib google code site.
   
The column at which to enter miser style. Depending on the dispatch table, 
 miser style add newlines in more places to try to keep lines short allowing for further 
 levels of nesting.

-  Source
+  Source
 

   

   
*print-pprint-dispatch*

@@ -203,14 +203,14 @@ levels of nesting.
   

   
The pretty print dispatch function. Use with-pprint-dispatch or set-pprint-dispatch
 to modify.

-  Source
+  Source
 

   

   
*print-pretty*

   var

   

   
Bind to true if you want write to use pretty printing

-  Source
+  Source
 

   

   
*print-radix*

@@ -219,7 +219,7 @@ to modify.
   
Print a radix specifier in front of integers and rationals. If *print-base* is 2, 8, 
 or 16, then the radix specifier used is #b, #o, or #x, respectively. Otherwise the 
 radix specifier is in the form #XXr where XX is the decimal value of *print-base* 

-  Source
+  Source
 

   

   
*print-right-margin*

@@ -228,14 +228,14 @@ radix specifier is in the form #XXr where XX is the decimal value of *print-base
   
Pretty printing will try to avoid anything going beyond this column.
 Set it to nil to have pprint let the line be arbitrarily long. This will ignore all 
 non-mandatory newlines.

-  Source
+  Source
 

   

   
*print-shared*

   var

   

   
Mark repeated structures rather than repeat them (N.B. This is not yet used)

-  Source
+  Source
 

   

   
*print-suppress-namespaces*

@@ -243,7 +243,7 @@ non-mandatory newlines.
   

   
Don't print namespaces with symbols. This is particularly useful when 
 pretty printing the results of macro expansions

-  Source
+  Source
 

   

   
*simple-dispatch*

@@ -251,7 +251,7 @@ pretty printing the results of macro expansions
   
Usage: (*simple-dispatch* object)
 

   
The pretty print dispatch function for simple data structure format.

-  Source
+  Source
 

   

   
cl-format

@@ -285,7 +285,7 @@ Language, 2nd edition", Chapter 22 (available online at:
 http://www.cs.cmu.edu/afs/cs.cmu.edu/project/ai-repository/ai/html/cltl/clm/node200.html#SECTION002633000000000000000) 
 and in the Common Lisp HyperSpec at 
 http://www.lispworks.com/documentation/HyperSpec/Body/22_c.htm
-  Source
+  Source
 

   

   
compile-format

@@ -295,7 +295,7 @@ and in the Common Lisp HyperSpec at
   
Compiles format-str into a compiled format which can be used as an argument
 to cl-format just like a plain format string. Use this function for improved 
 performance when you're using the same format string repeatedly

-  Source
+  Source
 

   

   
formatter

@@ -307,7 +307,7 @@ fn [stream & args] ... and returns nil unless the stream is nil (meaning
 output to a string) in which case it returns the resulting string.
 
 format-in can be either a control string or a previously compiled format.
-  Source
+  Source
 

   

   
formatter-out

@@ -320,7 +320,7 @@ designed to be used with *out* set to an appropriate Writer. In particular,
 this is meant to be used as part of a pretty printer dispatch method.
 
 format-in can be either a control string or a previously compiled format.
-  Source
+  Source
 

   

   
fresh-line

@@ -329,7 +329,7 @@ format-in can be either a control string or a previously compiled format.
 
   
Make a newline if the Writer is not already at the beginning of the line.
 N.B. Only works on ColumnWriters right now.

-  Source
+  Source
 

   

   
pp

@@ -338,7 +338,7 @@ N.B. Only works on ColumnWriters right now.
 
   
A convenience macro that pretty prints the last thing output. This is
 exactly equivalent to (pprint *1).

-  Source
+  Source
 

   

   
pprint

@@ -348,7 +348,7 @@ exactly equivalent to (pprint *1).
 
   
Pretty print object to the optional output writer. If the writer is not provided, 
 print the object to the currently bound value of *out*.

-  Source
+  Source
 

   

   
pprint-indent

@@ -361,7 +361,7 @@ whether the indent should be computed relative to the start of the logical block
 the current column position. n is an offset. 
 
 Output is sent to *out* which must be a pretty printing writer.
-  Source
+  Source
 

   

   
pprint-logical-block

@@ -374,7 +374,7 @@ assumed.
 
 Before the body, the caller can optionally specify options: :prefix, :per-line-prefix, 
 and :suffix.
-  Source
+  Source
 

   

   
pprint-newline

@@ -385,7 +385,7 @@ and :suffix.
 newline is :linear, :miser, :fill, or :mandatory. 
 
 Output is sent to *out* which must be a pretty printing writer.
-  Source
+  Source
 

   

   
pprint-tab

@@ -401,7 +401,7 @@ forward if the output is already past the original target.
 Output is sent to *out* which must be a pretty printing writer.
 
 THIS FUNCTION IS NOT YET IMPLEMENTED.
-  Source
+  Source
 

   

   
set-pprint-dispatch

@@ -414,7 +414,7 @@ to a pretty printing writer to which it should do its printing.
 
 For example functions, see *simple-dispatch* and *code-dispatch* in 
 clojure.contrib.pprint.dispatch.clj.
-  Source
+  Source
 

   

   
use-method

@@ -422,7 +422,7 @@ clojure.contrib.pprint.dispatch.clj.
   
Usage: (use-method multifn dispatch-val func)
 

   
Installs a function as a new method of multimethod associated with dispatch-value. 

-  Source
+  Source
 

   

   
with-pprint-dispatch

@@ -430,7 +430,7 @@ clojure.contrib.pprint.dispatch.clj.
   
Usage: (with-pprint-dispatch function & body)
 

   
Execute body with the pretty print dispatch function bound to function.

-  Source
+  Source
 

   

   
write

@@ -458,7 +458,7 @@ The following keyword arguments can be passed with values:
   :suppress-namespaces If true, no namespaces in symbols    Current value of *print-suppress-namespaces*
 
   * = not yet supported
-  Source
+  Source
 

   

   
write-out

@@ -475,7 +475,7 @@ of the caller.
 This method is primarily intended for use by pretty print dispatch functions that 
 already know that the pretty printer will have set up their environment appropriately.
 Normal library clients should use the standard "write" interface. 
-  Source
+  Source
 

 
pprint.examples.json

 
Pretty printing JavaScript Object Notation (JSON) generator.
@@ -493,7 +493,7 @@ This is an example of using a pretty printer dispatch function to generate JSON
   
Usage: (dispatch-json x)
 

   
The dispatch function for printing objects as JSON

-  Source
+  Source
 

   

   
json-str

@@ -501,7 +501,7 @@ This is an example of using a pretty printer dispatch function to generate JSON
   
Usage: (json-str x)
 

   
Converts x to a JSON-formatted string.

-  Source
+  Source
 

   

   
print-json

@@ -513,7 +513,7 @@ strings, without the leading colon.  Maps become JSON objects, all
 other collection types become JSON arrays.  Java arrays become JSON
 arrays.  Unicode characters in strings are escaped as \uXXXX.
 Numbers print as with pr.
-  Source
+  Source
 

 
pprint.examples.xml

 
A version of prxml that uses a pretty print dispatch function.

@@ -524,14 +524,14 @@ Numbers print as with pr.
   var

   

   
If true, empty tags will have a space before the closing />

-  Source
+  Source
 

   

   
*prxml-indent*

   var

   

   
The number of spaces to indent sub-tags.

-  Source
+  Source
 

   

   
prxml

@@ -560,7 +560,7 @@ PSEUDO-TAGS: some keywords have special meaning:
 
   (prxml [:decl! {:version "1.1"}])
   ; => <?xml version="1.1" encoding="UTF-8"?>
-  Source
+  Source
 

 
 
-- 
cgit v1.2.3-18-g5258