aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Faulhaber <git_net@infolace.com>2009-11-24 18:14:47 -0800
committerTom Faulhaber <git_net@infolace.com>2009-11-24 18:14:47 -0800
commit2b22768e3414e1210884fe64e6032e6fbfa369e2 (patch)
treeaea9f0e8240105a9693210bbe8965f60367ae07c
parenta91eaf49d2494ca099bc622d2ccc4431abf63202 (diff)
Updated documentation for commit ec3a9d1fc37db63245ec6a3c672725add7633bd2
-rw-r--r--api-index.json12
-rw-r--r--pprint-api.html10
2 files changed, 11 insertions, 11 deletions
diff --git a/api-index.json b/api-index.json
index cf5e5a0c..6eb98eb8 100644
--- a/api-index.json
+++ b/api-index.json
@@ -381,7 +381,7 @@
"author":"Stephen C. Gilardi",
"doc":"Namespace utilities"},
{"source-url":
- "http://github.com/richhickey/clojure-contrib/blob/9382430b2dc04761a7c1781c30a737cc5a04566a/src/clojure/contrib/pprint.clj",
+ "http://github.com/richhickey/clojure-contrib/blob/ec3a9d1fc37db63245ec6a3c672725add7633bd2/src/clojure/contrib/pprint.clj",
"wiki-url":
"http://richhickey.github.com/clojure-contrib/pprint-api.html",
"name":"clojure.contrib.pprint",
@@ -4052,7 +4052,7 @@
"The pretty print dispatch function for simple data structure format.",
"name":"*simple-dispatch*"},
{"source-url":
- "http://github.com/richhickey/clojure-contrib/blob/6f9e9c276bf53b0fce2275abf29a25f9735a6409/src/clojure/contrib/pprint/cl-format.clj#L26",
+ "http://github.com/richhickey/clojure-contrib/blob/ec3a9d1fc37db63245ec6a3c672725add7633bd2/src/clojure/contrib/pprint/cl_format.clj#L26",
"wiki-url":
"http://richhickey.github.com/clojure-contrib//pprint-api.html#pprint/cl-format",
"namespace":"clojure.contrib.pprint",
@@ -4061,7 +4061,7 @@
"An implementation of a Common Lisp compatible format function. cl-format formats its\narguments to an output stream or string based on the format control string given. It \nsupports sophisticated formatting of structured data.\n\nWriter is an instance of java.io.Writer, true to output to *out* or nil to output \nto a string, format-in is the format control string and the remaining arguments \nare the data to be formatted.\n\nThe format control string is a string to be output with embedded 'format directives' \ndescribing how to format the various arguments passed in.\n\nIf writer is nil, cl-format returns the formatted result string. Otherwise, cl-format \nreturns nil.\n\nFor example:\n (let [results [46 38 22]]\n (cl-format true \"There ~[are~;is~:;are~]~:* ~d result~:p: ~{~d~^, ~}~%\" \n (count results) results))\n\nPrints to *out*:\n There are 3 results: 46, 38, 22\n\nDetailed documentation on format control strings is available in the \"Common Lisp the \nLanguage, 2nd edition\", Chapter 22 (available online at:\nhttp://www.cs.cmu.edu/afs/cs.cmu.edu/project/ai-repository/ai/html/cltl/clm/node200.html#SECTION002633000000000000000) \nand in the Common Lisp HyperSpec at \nhttp://www.lispworks.com/documentation/HyperSpec/Body/22_c.htm",
"name":"cl-format"},
{"source-url":
- "http://github.com/richhickey/clojure-contrib/blob/6f9e9c276bf53b0fce2275abf29a25f9735a6409/src/clojure/contrib/pprint/cl-format.clj#L1749",
+ "http://github.com/richhickey/clojure-contrib/blob/ec3a9d1fc37db63245ec6a3c672725add7633bd2/src/clojure/contrib/pprint/cl_format.clj#L1749",
"wiki-url":
"http://richhickey.github.com/clojure-contrib//pprint-api.html#pprint/compile-format",
"namespace":"clojure.contrib.pprint",
@@ -4070,7 +4070,7 @@
"Compiles format-str into a compiled format which can be used as an argument\nto cl-format just like a plain format string. Use this function for improved \nperformance when you're using the same format string repeatedly",
"name":"compile-format"},
{"source-url":
- "http://github.com/richhickey/clojure-contrib/blob/6f9e9c276bf53b0fce2275abf29a25f9735a6409/src/clojure/contrib/pprint/cl-format.clj#L1817",
+ "http://github.com/richhickey/clojure-contrib/blob/ec3a9d1fc37db63245ec6a3c672725add7633bd2/src/clojure/contrib/pprint/cl_format.clj#L1817",
"wiki-url":
"http://richhickey.github.com/clojure-contrib//pprint-api.html#pprint/formatter",
"namespace":"clojure.contrib.pprint",
@@ -4079,7 +4079,7 @@
"Makes a function which can directly run format-in. The function is\nfn [stream & args] ... and returns nil unless the stream is nil (meaning \noutput to a string) in which case it returns the resulting string.\n\nformat-in can be either a control string or a previously compiled format.",
"name":"formatter"},
{"source-url":
- "http://github.com/richhickey/clojure-contrib/blob/6f9e9c276bf53b0fce2275abf29a25f9735a6409/src/clojure/contrib/pprint/cl-format.clj#L1831",
+ "http://github.com/richhickey/clojure-contrib/blob/ec3a9d1fc37db63245ec6a3c672725add7633bd2/src/clojure/contrib/pprint/cl_format.clj#L1831",
"wiki-url":
"http://richhickey.github.com/clojure-contrib//pprint-api.html#pprint/formatter-out",
"namespace":"clojure.contrib.pprint",
@@ -4088,7 +4088,7 @@
"Makes a function which can directly run format-in. The function is\nfn [& args] ... and returns nil. This version of the formatter macro is\ndesigned to be used with *out* set to an appropriate Writer. In particular,\nthis is meant to be used as part of a pretty printer dispatch method.\n\nformat-in can be either a control string or a previously compiled format.",
"name":"formatter-out"},
{"source-url":
- "http://github.com/richhickey/clojure-contrib/blob/6f9e9c276bf53b0fce2275abf29a25f9735a6409/src/clojure/contrib/pprint/cl-format.clj#L1153",
+ "http://github.com/richhickey/clojure-contrib/blob/ec3a9d1fc37db63245ec6a3c672725add7633bd2/src/clojure/contrib/pprint/cl_format.clj#L1153",
"wiki-url":
"http://richhickey.github.com/clojure-contrib//pprint-api.html#pprint/fresh-line",
"namespace":"clojure.contrib.pprint",
diff --git a/pprint-api.html b/pprint-api.html
index ac47a1b6..7ab2dbe6 100644
--- a/pprint-api.html
+++ b/pprint-api.html
@@ -293,7 +293,7 @@ Language, 2nd edition", Chapter 22 (available online at:
<a href="http://www.cs.cmu.edu/afs/cs.cmu.edu/project/ai-repository/ai/html/cltl/clm/node200.html#SECTION002633000000000000000)">http://www.cs.cmu.edu/afs/cs.cmu.edu/project/ai-repository/ai/html/cltl/clm/node200.html#SECTION002633000000000000000)</a>
and in the Common Lisp HyperSpec at
<a href="http://www.lispworks.com/documentation/HyperSpec/Body/22_c.htm">http://www.lispworks.com/documentation/HyperSpec/Body/22_c.htm</a></pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/6f9e9c276bf53b0fce2275abf29a25f9735a6409/src/clojure/contrib/pprint/cl-format.clj#L26" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/ec3a9d1fc37db63245ec6a3c672725add7633bd2/src/clojure/contrib/pprint/cl_format.clj#L26" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -304,7 +304,7 @@ and in the Common Lisp HyperSpec at
<pre id="var-docstr">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</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/6f9e9c276bf53b0fce2275abf29a25f9735a6409/src/clojure/contrib/pprint/cl-format.clj#L1749" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/ec3a9d1fc37db63245ec6a3c672725add7633bd2/src/clojure/contrib/pprint/cl_format.clj#L1749" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -317,7 +317,7 @@ fn [stream &amp; 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.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/6f9e9c276bf53b0fce2275abf29a25f9735a6409/src/clojure/contrib/pprint/cl-format.clj#L1817" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/ec3a9d1fc37db63245ec6a3c672725add7633bd2/src/clojure/contrib/pprint/cl_format.clj#L1817" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -331,7 +331,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.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/6f9e9c276bf53b0fce2275abf29a25f9735a6409/src/clojure/contrib/pprint/cl-format.clj#L1831" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/ec3a9d1fc37db63245ec6a3c672725add7633bd2/src/clojure/contrib/pprint/cl_format.clj#L1831" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -341,7 +341,7 @@ format-in can be either a control string or a previously compiled format.</pre>
</pre>
<pre id="var-docstr">Make a newline if the Writer is not already at the beginning of the line.
N.B. Only works on ColumnWriters right now.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/6f9e9c276bf53b0fce2275abf29a25f9735a6409/src/clojure/contrib/pprint/cl-format.clj#L1153" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/ec3a9d1fc37db63245ec6a3c672725add7633bd2/src/clojure/contrib/pprint/cl_format.clj#L1153" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />