diff options
author | Tom Faulhaber <git_net@infolace.com> | 2010-05-13 11:50:10 -0700 |
---|---|---|
committer | Tom Faulhaber <git_net@infolace.com> | 2010-05-13 11:50:10 -0700 |
commit | a045b1aa22355285b899b698af58263cb6d3040c (patch) | |
tree | 32f3836063079510a9b8b95d295cebdd212806fa | |
parent | c4023aa6b8182bc91e863f5c241fcead910fed76 (diff) |
Manual documentation update
-rw-r--r-- | api-index.html | 25 | ||||
-rw-r--r-- | def-api.html | 24 | ||||
-rw-r--r-- | gen-html-docs-api.html | 4 | ||||
-rw-r--r-- | index.html | 21 | ||||
-rw-r--r-- | io-api.html | 170 | ||||
-rw-r--r-- | pprint-api.html | 10 | ||||
-rw-r--r-- | seq-api.html | 155 | ||||
-rw-r--r-- | seq-utils-api.html | 155 |
8 files changed, 383 insertions, 181 deletions
diff --git a/api-index.html b/api-index.html index 7c45e1a9..5f67e16c 100644 --- a/api-index.html +++ b/api-index.html @@ -156,7 +156,8 @@ Shortcuts:<br /> </div><div id="index-body"> <h2 id="C"><span id="section-head">C</span></h2> <pre> -<span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*code-dispatch*">*code-dispatch*</a><span id="line-content"> multimethod pprint The pretty print dispatch function for pretty prin... +<span id="section-content"> <a href="io-api.html#clojure.contrib.io/*char-array-type*">*char-array-type*</a><span id="line-content"> var io Type object for a Java primitive char array.. +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*code-dispatch*">*code-dispatch*</a><span id="line-content"> multimethod pprint The pretty print dispatch function for pretty prin... </span></span><span id="section-content"> <a href="jmx-api.html#clojure.contrib.jmx/*connection*">*connection*</a><span id="line-content"> var jmx The connection to be used for JMX ops. Defaults to... </span></span><span id="section-content"> <a href="monads-api.html#clojure.contrib.monads/call-cc">call-cc</a><span id="line-content"> function monads A computation in the cont monad that calls functio... </span></span><span id="section-content"> <a href="reflect-api.html#clojure.contrib.reflect/call-method">call-method</a><span id="line-content"> function reflect Calls a private or protected method. params is a ... @@ -343,6 +344,8 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="test-is-api.html#clojure.contrib.test-is/find-pure-exprs">find-pure-exprs</a><span id="line-content"> function test-is Recursively finds all sub-expressions in form that... </span></span><span id="section-content"> <a href="test-is-api.html#clojure.contrib.test-is/find-symbols">find-symbols</a><span id="line-content"> function test-is Recursively finds all symbols in form.. </span></span><span id="section-content"> <a href="graph-api.html#clojure.contrib.graph/fixed-point">fixed-point</a><span id="line-content"> function graph Repeatedly apply fun to data until (equal old-data... +</span></span><span id="section-content"> <a href="seq-api.html#clojure.contrib.seq/flatten">flatten</a><span id="line-content"> function seq DEPRECATED. Prefer clojure.core version. Takes any... +</span></span><span id="section-content"> <a href="seq-utils-api.html#clojure.contrib.seq-utils/flatten">flatten</a><span id="line-content"> function seq-utils DEPRECATED. Prefer clojure.core version. Takes any... </span></span><span id="section-content"> <a href="test-is-api.html#clojure.contrib.test-is/flatten-map">flatten-map</a><span id="line-content"> function test-is Transforms a map into a vector like [key value key... </span></span><span id="section-content"> <a href="generic.math-functions-api.html#clojure.contrib.generic.math-functions/floor">floor</a><span id="line-content"> multimethod generic.math-functions Return the floor of x.. </span></span><span id="section-content"> <a href="math-api.html#clojure.contrib.math/floor">floor</a><span id="line-content"> multimethod math (floor n) returns the greatest integer less than o... @@ -351,6 +354,8 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="fnmap-api.html#clojure.contrib.fnmap/fnmap">fnmap</a><span id="line-content"> function fnmap Creates a fnmap, or functional map. A fnmap behav... </span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/formatter">formatter</a><span id="line-content"> macro pprint Makes a function which can directly run format-in.... </span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/formatter-out">formatter-out</a><span id="line-content"> macro pprint Makes a function which can directly run format-in.... +</span></span><span id="section-content"> <a href="seq-api.html#clojure.contrib.seq/frequencies">frequencies</a><span id="line-content"> function seq DEPRECATED. Prefer clojure.core version. Returns a... +</span></span><span id="section-content"> <a href="seq-utils-api.html#clojure.contrib.seq-utils/frequencies">frequencies</a><span id="line-content"> function seq-utils DEPRECATED. Prefer clojure.core version. Returns a... </span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/fresh-line">fresh-line</a><span id="line-content"> function pprint Make a newline if the Writer is not already at the... </span></span><span id="section-content"> <a href="test-is-api.html#clojure.contrib.test-is/function?">function?</a><span id="line-content"> function test-is Returns true if argument is a function or a symbol... </span></span></pre> @@ -382,6 +387,8 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="greatest-least-api.html#clojure.contrib.greatest-least/greatest-by">greatest-by</a><span id="line-content"> function greatest-least Return the argument for which f yields the greates... </span></span><span id="section-content"> <a href="str-utils2-api.html#clojure.contrib.str-utils2/grep">grep</a><span id="line-content"> function str-utils2 Filters elements of coll by a regular expression. ... </span></span><span id="section-content"> <a href="string-api.html#clojure.contrib.string/grep">grep</a><span id="line-content"> function string Filters elements of coll by a regular expression. ... +</span></span><span id="section-content"> <a href="seq-api.html#clojure.contrib.seq/group-by">group-by</a><span id="line-content"> function seq DEPRECATED. Prefer clojure.core version. Returns ... +</span></span><span id="section-content"> <a href="seq-utils-api.html#clojure.contrib.seq-utils/group-by">group-by</a><span id="line-content"> function seq-utils DEPRECATED. Prefer clojure.core version. Returns ... </span></span><span id="section-content"> <a href="jmx-api.html#clojure.contrib.jmx/guess-attribute-typename">guess-attribute-typename</a><span id="line-content"> function jmx Guess the attribute typename for MBeanAttributeInf... </span></span></pre> </div><div id="index-body"> @@ -409,10 +416,11 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="import-static-api.html#clojure.contrib.import-static/import-static">import-static</a><span id="line-content"> macro import-static Imports the named static fields and/or static meth... </span></span><span id="section-content"> <a href="fcase-api.html#clojure.contrib.fcase/in-case">in-case</a><span id="line-content"> macro fcase Like case, but test expressions are sequences. Th... </span></span><span id="section-content"> <a href="test-is-api.html#clojure.contrib.test-is/inc-report-counter">inc-report-counter</a><span id="line-content"> function test-is Increments the named counter in *report-counters*,... +</span></span><span id="section-content"> <a href="seq-api.html#clojure.contrib.seq/includes?">includes?</a><span id="line-content"> function seq Returns true if coll contains something equal (wit... +</span></span><span id="section-content"> <a href="seq-utils-api.html#clojure.contrib.seq-utils/includes?">includes?</a><span id="line-content"> function seq-utils Returns true if coll contains something equal (wit... </span></span><span id="section-content"> <a href="seq-api.html#clojure.contrib.seq/indexed">indexed</a><span id="line-content"> function seq Returns a lazy sequence of [index, item] pairs, wh... </span></span><span id="section-content"> <a href="seq-utils-api.html#clojure.contrib.seq-utils/indexed">indexed</a><span id="line-content"> function seq-utils Returns a lazy sequence of [index, item] pairs, wh... </span></span><span id="section-content"> <a href="logging-api.html#clojure.contrib.logging/info">info</a><span id="line-content"> macro logging Logs a message at the info level.. -</span></span><span id="section-content"> <a href="io-api.html#clojure.contrib.io/input-stream">input-stream</a><span id="line-content"> multimethod io Attempts to coerce its argument into an open java.... </span></span><span id="section-content"> <a href="sql-api.html#clojure.contrib.sql/insert-records">insert-records</a><span id="line-content"> function sql Inserts records into a table. records are maps fro... </span></span><span id="section-content"> <a href="sql-api.html#clojure.contrib.sql/insert-rows">insert-rows</a><span id="line-content"> function sql Inserts complete rows into a table. Each row is a ... </span></span><span id="section-content"> <a href="sql-api.html#clojure.contrib.sql/insert-values">insert-values</a><span id="line-content"> function sql Inserts rows into a table with values for specifie... @@ -532,7 +540,6 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="jmx-api.html#clojure.contrib.jmx/operation">operation</a><span id="line-content"> function jmx The MBeanOperationInfo for operation op on mbean n... </span></span><span id="section-content"> <a href="jmx-api.html#clojure.contrib.jmx/operation-names">operation-names</a><span id="line-content"> function jmx All operation names available on an MBean.. </span></span><span id="section-content"> <a href="jmx-api.html#clojure.contrib.jmx/operations">operations</a><span id="line-content"> function jmx All oeprations available on an MBean.. -</span></span><span id="section-content"> <a href="io-api.html#clojure.contrib.io/output-stream">output-stream</a><span id="line-content"> multimethod io Attempts to coerce its argument into an open java.... </span></span></pre> </div><div id="index-body"> <h2 id="P"><span id="section-head">P</span></h2> @@ -553,6 +560,10 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="str-utils2-api.html#clojure.contrib.str-utils2/partial">partial</a><span id="line-content"> function str-utils2 Like clojure.core/partial for functions that take ... </span></span><span id="section-content"> <a href="str-utils2-api.html#clojure.contrib.str-utils2/partition">partition</a><span id="line-content"> function str-utils2 Splits the string into a lazy sequence of substrin... </span></span><span id="section-content"> <a href="string-api.html#clojure.contrib.string/partition">partition</a><span id="line-content"> function string Splits the string into a lazy sequence of substrin... +</span></span><span id="section-content"> <a href="seq-api.html#clojure.contrib.seq/partition-all">partition-all</a><span id="line-content"> function seq DEPRECATED. Prefer clojure.core version. Returns a... +</span></span><span id="section-content"> <a href="seq-utils-api.html#clojure.contrib.seq-utils/partition-all">partition-all</a><span id="line-content"> function seq-utils DEPRECATED. Prefer clojure.core version. Returns a... +</span></span><span id="section-content"> <a href="seq-api.html#clojure.contrib.seq/partition-by">partition-by</a><span id="line-content"> function seq DEPRECATED. Prefer clojure.core version. Applies f... +</span></span><span id="section-content"> <a href="seq-utils-api.html#clojure.contrib.seq-utils/partition-by">partition-by</a><span id="line-content"> function seq-utils DEPRECATED. Prefer clojure.core version. Applies f... </span></span><span id="section-content"> <a href="singleton-api.html#clojure.contrib.singleton/per-thread-singleton">per-thread-singleton</a><span id="line-content"> function singleton Returns a per-thread singleton function. f is a f... </span></span><span id="section-content"> <a href="combinatorics-api.html#clojure.contrib.combinatorics/permutations">permutations</a><span id="line-content"> function combinatorics All the permutations of items, lexicographic by in... </span></span><span id="section-content"> <a href="stream-utils-api.html#clojure.contrib.stream-utils/pick">pick</a><span id="line-content"> function stream-utils Return the next value of stream argument n inside ... @@ -601,6 +612,8 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="condition-api.html#clojure.contrib.condition/raise">raise</a><span id="line-content"> macro condition Raises a condition. With no arguments, re-raises t... </span></span><span id="section-content"> <a href="error-kit-api.html#clojure.contrib.error-kit/raise">raise</a><span id="line-content"> macro error-kit Raise an error of the type err-name, constructed w... </span></span><span id="section-content"> <a href="error-kit-api.html#clojure.contrib.error-kit/raise*">raise*</a><span id="line-content"> function error-kit Raise the given error object, best if created by a... +</span></span><span id="section-content"> <a href="seq-api.html#clojure.contrib.seq/rand-elt">rand-elt</a><span id="line-content"> function seq DEPRECATED. Prefer clojure.core/rand-nth. Return a... +</span></span><span id="section-content"> <a href="seq-utils-api.html#clojure.contrib.seq-utils/rand-elt">rand-elt</a><span id="line-content"> function seq-utils DEPRECATED. Prefer clojure.core/rand-nth. Return a... </span></span><span id="section-content"> <a href="probabilities.random-numbers-api.html#clojure.contrib.probabilities.random-numbers/rand-stream">rand-stream</a><span id="line-content"> var probabilities.random-numbers A random number stream based on clojure.... </span></span><span id="section-content"> <a href="probabilities.monte-carlo-api.html#clojure.contrib.probabilities.monte-carlo/random-stream">random-stream</a><span id="line-content"> function probabilities.monte-carlo Define a random stream by a distribution an... </span></span><span id="section-content"> <a href="jmx-api.html#clojure.contrib.jmx/raw-read">raw-read</a><span id="line-content"> function jmx Read an mbean property. Returns low-level Java obj... @@ -624,13 +637,14 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="jmx-api.html#clojure.contrib.jmx/read-supported">read-supported</a><span id="line-content"> function jmx Calls read to read an mbean property, *returning* ... </span></span><span id="section-content"> <a href="jmx-api.html#clojure.contrib.jmx/readable?">readable?</a><span id="line-content"> function jmx Is attribute readable?. </span></span><span id="section-content"> <a href="duck-streams-api.html#clojure.contrib.duck-streams/reader">reader</a><span id="line-content"> multimethod duck-streams Attempts to coerce its argument into an open java.... -</span></span><span id="section-content"> <a href="io-api.html#clojure.contrib.io/reader">reader</a><span id="line-content"> multimethod io Attempts to coerce its argument into an open java.... </span></span><span id="section-content"> <a href="seq-api.html#clojure.contrib.seq/rec-cat">rec-cat</a><span id="line-content"> macro seq Similar to lazy-cat but binds the resulting sequen... </span></span><span id="section-content"> <a href="seq-utils-api.html#clojure.contrib.seq-utils/rec-cat">rec-cat</a><span id="line-content"> macro seq-utils Similar to lazy-cat but binds the resulting sequen... </span></span><span id="section-content"> <a href="seq-api.html#clojure.contrib.seq/rec-seq">rec-seq</a><span id="line-content"> macro seq Similar to lazy-seq but binds the resulting seq to... </span></span><span id="section-content"> <a href="seq-utils-api.html#clojure.contrib.seq-utils/rec-seq">rec-seq</a><span id="line-content"> macro seq-utils Similar to lazy-seq but binds the resulting seq to... </span></span><span id="section-content"> <a href="graph-api.html#clojure.contrib.graph/recursive-component?">recursive-component?</a><span id="line-content"> function graph Is the component (recieved from scc) self recursiv... </span></span><span id="section-content"> <a href="http.agent-api.html#clojure.contrib.http.agent/redirect?">redirect?</a><span id="line-content"> function http.agent Returns true if the HTTP response code was in the ... +</span></span><span id="section-content"> <a href="seq-api.html#clojure.contrib.seq/reductions">reductions</a><span id="line-content"> function seq DEPRECATED. Prefer clojure.core version. Returns a... +</span></span><span id="section-content"> <a href="seq-utils-api.html#clojure.contrib.seq-utils/reductions">reductions</a><span id="line-content"> function seq-utils DEPRECATED. Prefer clojure.core version. Returns a... </span></span><span id="section-content"> <a href="probabilities.monte-carlo-api.html#clojure.contrib.probabilities.monte-carlo/reject">reject</a><span id="line-content"> function probabilities.monte-carlo Return the distribution that results from r... </span></span><span id="section-content"> <a href="io-api.html#clojure.contrib.io/relative-path-string">relative-path-string</a><span id="line-content"> multimethod io Interpret a String or java.io.File as a relative p... </span></span><span id="section-content"> <a href="java-utils-api.html#clojure.contrib.java-utils/relative-path-string">relative-path-string</a><span id="line-content"> multimethod java-utils Interpret a String or java.io.File as a relative p... @@ -713,6 +727,8 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="shell-api.html#clojure.contrib.shell/sh">sh</a><span id="line-content"> function shell Passes the given strings to Runtime.exec() to laun... </span></span><span id="section-content"> <a href="shell-out-api.html#clojure.contrib.shell-out/sh">sh</a><span id="line-content"> function shell-out Passes the given strings to Runtime.exec() to laun... </span></span><span id="section-content"> <a href="repl-utils-api.html#clojure.contrib.repl-utils/show">show</a><span id="line-content"> function repl-utils With one arg prints all static and instance member... +</span></span><span id="section-content"> <a href="seq-api.html#clojure.contrib.seq/shuffle">shuffle</a><span id="line-content"> function seq DEPRECATED. Prefer clojure.core version. Return a ... +</span></span><span id="section-content"> <a href="seq-utils-api.html#clojure.contrib.seq-utils/shuffle">shuffle</a><span id="line-content"> function seq-utils DEPRECATED. Prefer clojure.core version. Return a ... </span></span><span id="section-content"> <a href="generic.math-functions-api.html#clojure.contrib.generic.math-functions/sin">sin</a><span id="line-content"> multimethod generic.math-functions Return the sin of x.. </span></span><span id="section-content"> <a href="monadic-io-streams-api.html#clojure.contrib.monadic-io-streams/skip-chars">skip-chars</a><span id="line-content"> function monadic-io-streams Skip n characters. </span></span><span id="section-content"> <a href="mmap-api.html#clojure.contrib.mmap/slurp">slurp</a><span id="line-content"> function mmap Reads the file named by f and returns it as a stri... @@ -855,7 +871,6 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="java-utils-api.html#clojure.contrib.java-utils/write-properties">write-properties</a><span id="line-content"> function java-utils Write properties to file-able.. </span></span><span id="section-content"> <a href="properties-api.html#clojure.contrib.properties/write-properties">write-properties</a><span id="line-content"> function properties Write properties to file-able.. </span></span><span id="section-content"> <a href="duck-streams-api.html#clojure.contrib.duck-streams/writer">writer</a><span id="line-content"> multimethod duck-streams Attempts to coerce its argument into an open java.... -</span></span><span id="section-content"> <a href="io-api.html#clojure.contrib.io/writer">writer</a><span id="line-content"> multimethod io Attempts to coerce its argument into an open java.... </span></span><span id="section-content"> <a href="monads-api.html#clojure.contrib.monads/writer-m">writer-m</a><span id="line-content"> function monads Monad describing computations that accumulate data... </span></span></pre> </div><div id="index-body"> diff --git a/def-api.html b/def-api.html index d921ce27..035e7d75 100644 --- a/def-api.html +++ b/def-api.html @@ -109,7 +109,7 @@ any) and similar metadata. The metadata of the alias is its initial metadata (as provided by def) merged into the metadata of the original.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L66" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/1c805bd0e515ea57028721ea54e6db4b0c791e20/src/main/clojure/clojure/contrib/def.clj#L66" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -122,7 +122,7 @@ init. Be careful about using any form of 'def' or 'binding' to a value of a different type. See <a href="http://paste.lisp.org/display/73344">http://paste.lisp.org/display/73344</a></pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L83" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/1c805bd0e515ea57028721ea54e6db4b0c791e20/src/main/clojure/clojure/contrib/def.clj#L85" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -133,7 +133,7 @@ value of a different type. See <a href="http://paste.lisp.org/display/73344">ht <pre id="var-docstr">Same as defmacro but yields a private definition</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L39" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/1c805bd0e515ea57028721ea54e6db4b0c791e20/src/main/clojure/clojure/contrib/def.clj#L39" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -144,7 +144,7 @@ value of a different type. See <a href="http://paste.lisp.org/display/73344">ht <pre id="var-docstr">Just like defn, but memoizes the function using clojure.core/memoize</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L141" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/1c805bd0e515ea57028721ea54e6db4b0c791e20/src/main/clojure/clojure/contrib/def.clj#L143" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -160,7 +160,7 @@ virtue of the symbol corresponding to the keyword (cf. :keys destructuring). defnk accepts an optional docstring as well as an optional metadata map.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L120" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/1c805bd0e515ea57028721ea54e6db4b0c791e20/src/main/clojure/clojure/contrib/def.clj#L122" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -172,7 +172,7 @@ defnk accepts an optional docstring as well as an optional metadata map.</pre> <pre id="var-docstr">Same as defonce but yields a private definition</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L59" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/1c805bd0e515ea57028721ea54e6db4b0c791e20/src/main/clojure/clojure/contrib/def.clj#L59" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -183,7 +183,7 @@ defnk accepts an optional docstring as well as an optional metadata map.</pre> <pre id="var-docstr">Same as defstruct but yields a private definition</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L54" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/1c805bd0e515ea57028721ea54e6db4b0c791e20/src/main/clojure/clojure/contrib/def.clj#L54" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -195,7 +195,7 @@ defnk accepts an optional docstring as well as an optional metadata map.</pre> <pre id="var-docstr">Defines an unbound var with optional doc string</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L32" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/1c805bd0e515ea57028721ea54e6db4b0c791e20/src/main/clojure/clojure/contrib/def.clj#L32" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -206,7 +206,7 @@ defnk accepts an optional docstring as well as an optional metadata map.</pre> <pre id="var-docstr">Same as defunbound but yields a private definition</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L49" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/1c805bd0e515ea57028721ea54e6db4b0c791e20/src/main/clojure/clojure/contrib/def.clj#L49" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -219,7 +219,7 @@ defnk accepts an optional docstring as well as an optional metadata map.</pre> <pre id="var-docstr">Defines a var with an optional intializer and doc string</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L23" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/1c805bd0e515ea57028721ea54e6db4b0c791e20/src/main/clojure/clojure/contrib/def.clj#L23" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -230,7 +230,7 @@ defnk accepts an optional docstring as well as an optional metadata map.</pre> <pre id="var-docstr">Same as defvar but yields a private definition</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L44" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/1c805bd0e515ea57028721ea54e6db4b0c791e20/src/main/clojure/clojure/contrib/def.clj#L44" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -249,7 +249,7 @@ with its extended metadata map and the list of unprocessed macro arguments.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L94" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/1c805bd0e515ea57028721ea54e6db4b0c791e20/src/main/clojure/clojure/contrib/def.clj#L96" id="var-source">Source</a> </div> diff --git a/gen-html-docs-api.html b/gen-html-docs-api.html index 5b3a62ee..6ac612c2 100644 --- a/gen-html-docs-api.html +++ b/gen-html-docs-api.html @@ -89,7 +89,7 @@ named by libs. Libs is a vector of symbols identifying Clojure libraries.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/b52f0b60c0e777724fa3591c43bdba83a16968c8/src/main/clojure/clojure/contrib/gen_html_docs.clj#L431" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/95dddbbdd748b0cc6d9c8486b8388836e6418848/src/main/clojure/clojure/contrib/gen_html_docs.clj#L431" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -101,7 +101,7 @@ libraries.</pre> emits the generated HTML to the path named by path.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/b52f0b60c0e777724fa3591c43bdba83a16968c8/src/main/clojure/clojure/contrib/gen_html_docs.clj#L457" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/95dddbbdd748b0cc6d9c8486b8388836e6418848/src/main/clojure/clojure/contrib/gen_html_docs.clj#L457" id="var-source">Source</a> </div> @@ -1056,21 +1056,18 @@ And you could write the response directly to a file like this: <h2 id="io">io</h2> by <span id="author">Stuart Sierra</span><br /> <a href="io-api.html" id="api-link">Detailed API documentation</a><br /> - <pre id="namespace-docstr">This file defines "duck-typed" I/O utility functions for Clojure. -The 'reader' and 'writer' functions will open and return an -instance of java.io.BufferedReader and java.io.PrintWriter, -respectively, for a variety of argument types -- filenames as -strings, URLs, java.io.File's, etc. 'reader' even works on http -URLs. + <pre id="namespace-docstr">This file defines polymorphic I/O utility functions for Clojure. -Note: this is not really "duck typing" as implemented in languages -like Ruby. A better name would have been "do-what-I-mean-streams" -or "just-give-me-a-stream", but ducks are funnier.</pre> +The Streams protocol defines reader, writer, input-stream and +output-stream methods that return BufferedReader, BufferedWriter, +BufferedInputStream and BufferedOutputStream instances (respectively), +with default implementations extended to a variety of argument +types: URLs or filenames as strings, java.io.File's, Sockets, etc.</pre> Public variables and functions: - <span id="var-link"><a href="io-api.html#clojure.contrib.io/*append*" id="var-tag">*append*</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/*buffer-size*" id="var-tag">*buffer-size*</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/*byte-array-type*" id="var-tag">*byte-array-type*</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/*default-encoding*" id="var-tag">*default-encoding*</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/append-output-stream" id="var-tag">append-output-stream</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/append-spit" id="var-tag">append-spit</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/append-writer" id="var-tag">append-writer</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/as-file" id="var-tag">as-file</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/as-url" id="var-tag">as-url</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/copy" id="var-tag">copy</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/delete-file" id="var-tag">delete-file</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/delete-file-recursively" id="var-tag">delete-file-recursively</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/file" id="var-tag">file</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/file-str" id="var-tag">file-str</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/input-stream" id="var-tag">input-stream</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/make-parents" id="var-tag">make-parents</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/output-stream" id="var-tag">output-stream</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/pwd" id="var-tag">pwd</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/read-lines" id="var-tag">read-lines</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/reader" id="var-tag">reader</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/relative-path-string" id="var-tag">relative-path-string</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/slurp*" id="var-tag">slurp*</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/spit" id="var-tag">spit</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/to-byte-array" id="var-tag">to-byte-array</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/with-in-reader" id="var-tag">with-in-reader</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/with-out-append-writer" id="var-tag">with-out-append-writer</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/with-out-writer" id="var-tag">with-out-writer</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/write-lines" id="var-tag">write-lines</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/writer" id="var-tag">writer</a> </span><br /> + <span id="var-link"><a href="io-api.html#clojure.contrib.io/*append*" id="var-tag">*append*</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/*buffer-size*" id="var-tag">*buffer-size*</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/*byte-array-type*" id="var-tag">*byte-array-type*</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/*char-array-type*" id="var-tag">*char-array-type*</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/*default-encoding*" id="var-tag">*default-encoding*</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/append-output-stream" id="var-tag">append-output-stream</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/append-spit" id="var-tag">append-spit</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/append-writer" id="var-tag">append-writer</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/as-file" id="var-tag">as-file</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/as-url" id="var-tag">as-url</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/copy" id="var-tag">copy</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/delete-file" id="var-tag">delete-file</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/delete-file-recursively" id="var-tag">delete-file-recursively</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/file" id="var-tag">file</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/file-str" id="var-tag">file-str</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/make-parents" id="var-tag">make-parents</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/pwd" id="var-tag">pwd</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/read-lines" id="var-tag">read-lines</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/relative-path-string" id="var-tag">relative-path-string</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/slurp*" id="var-tag">slurp*</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/spit" id="var-tag">spit</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/to-byte-array" id="var-tag">to-byte-array</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/with-in-reader" id="var-tag">with-in-reader</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/with-out-append-writer" id="var-tag">with-out-append-writer</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/with-out-writer" id="var-tag">with-out-writer</a> </span><span id="var-link"><a href="io-api.html#clojure.contrib.io/write-lines" id="var-tag">write-lines</a> </span><br /> </div><div id="namespace-entry"> <br /> @@ -1793,7 +1790,7 @@ input stream.</pre> Public variables and functions: - <span id="var-link"><a href="seq-api.html#clojure.contrib.seq/fill-queue" id="var-tag">fill-queue</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/find-first" id="var-tag">find-first</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/indexed" id="var-tag">indexed</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/positions" id="var-tag">positions</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/rec-cat" id="var-tag">rec-cat</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/rec-seq" id="var-tag">rec-seq</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/rotations" id="var-tag">rotations</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/separate" id="var-tag">separate</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/seq-on" id="var-tag">seq-on</a> </span><br /> + <span id="var-link"><a href="seq-api.html#clojure.contrib.seq/fill-queue" id="var-tag">fill-queue</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/find-first" id="var-tag">find-first</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/flatten" id="var-tag">flatten</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/frequencies" id="var-tag">frequencies</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/group-by" id="var-tag">group-by</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/includes?" id="var-tag">includes?</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/indexed" id="var-tag">indexed</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/partition-all" id="var-tag">partition-all</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/partition-by" id="var-tag">partition-by</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/positions" id="var-tag">positions</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/rand-elt" id="var-tag">rand-elt</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/rec-cat" id="var-tag">rec-cat</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/rec-seq" id="var-tag">rec-seq</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/reductions" id="var-tag">reductions</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/rotations" id="var-tag">rotations</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/separate" id="var-tag">separate</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/seq-on" id="var-tag">seq-on</a> </span><span id="var-link"><a href="seq-api.html#clojure.contrib.seq/shuffle" id="var-tag">shuffle</a> </span><br /> </div><div id="namespace-entry"> <br /> @@ -1806,7 +1803,7 @@ input stream.</pre> Public variables and functions: - <span id="var-link"><a href="seq-utils-api.html#clojure.contrib.seq-utils/fill-queue" id="var-tag">fill-queue</a> </span><span id="var-link"><a href="seq-utils-api.html#clojure.contrib.seq-utils/find-first" id="var-tag">find-first</a> </span><span id="var-link"><a href="seq-utils-api.html#clojure.contrib.seq-utils/indexed" id="var-tag">indexed</a> </span><span id="var-link"><a href="seq-utils-api.html#clojure.contrib.seq-utils/positions" id="var-tag">positions</a> </span><span id="var-link"><a href="seq-utils-api.html#clojure.contrib.seq-utils/rec-cat" id="var-tag">rec-cat</a> </span><span id="var-link"><a href="seq-utils-api.html#clojure.contrib.seq-utils/rec-seq" id="var-tag">rec-seq</a> </span><span id="var-link"><a href="seq-utils-api.html#clojure.contrib.seq-utils/rotations" id="var-tag">rotations</a> </span><span id="var-link"><a href="seq-utils-api.html#clojure.contrib.seq-utils/separate" id="var-tag">separate</a> </span><span id="var-link"><a href="seq-utils-api.html#clojure.contrib.seq-utils/seq-on" id="var-tag">seq-on</a> </span><br /> + <span id="var-link"><a href="seq-utils-api.html#clojure.contrib.seq-utils/fill-queue" id="var-tag">fill-queue</a> </span><span id="var-link"><a href="seq-utils-api.html#clojure.contrib.seq-utils/find-first" id="var-tag">find-first</a> </span><span id="var |