aboutsummaryrefslogtreecommitdiff
path: root/dataflow-api.html
diff options
context:
space:
mode:
authorTom Faulhaber <git_net@infolace.com>2010-04-30 16:19:00 -0700
committerTom Faulhaber <git_net@infolace.com>2010-04-30 16:19:00 -0700
commit4a3f270f93c687ec29f9cdd178f22b9fd3d82e37 (patch)
treecbe8efecfd3a0aab290cb6b7c2eec2135385d52a /dataflow-api.html
parentae92eda353beed7ff5ee07ea80491d7c7bca110c (diff)
Manual autodoc update (mostly whitespace diffs caused by new tags, not yet used).
Diffstat (limited to 'dataflow-api.html')
-rw-r--r--dataflow-api.html82
1 files changed, 62 insertions, 20 deletions
diff --git a/dataflow-api.html b/dataflow-api.html
index 7236e706..7515ee49 100644
--- a/dataflow-api.html
+++ b/dataflow-api.html
@@ -108,6 +108,8 @@ by <span id="author">Jeffrey Straszheim</span><br />
</pre><pre>
</pre><h2>Overview</h2>
<pre id="namespace-docstr">A library to support a dataflow model of state</pre>
+
+
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
@@ -121,7 +123,9 @@ by <span id="author">Jeffrey Straszheim</span><br />
function of 4 values: a key, the cell, its old value, its new
value. This is implemented using Clojure's add-watch to the
underlying ref, and shared its sematics</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L460" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -130,7 +134,9 @@ underlying ref, and shared its sematics</pre>
<pre id="var-usage">Usage: (add-cells df cells)
</pre>
<pre id="var-docstr">Given a collection of cells, add them to the dataflow.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L210" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -139,7 +145,9 @@ underlying ref, and shared its sematics</pre>
<pre id="var-usage">Usage: (build-dataflow cs)
</pre>
<pre id="var-docstr">Given a collection of cells, build and return a dataflow object</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L188" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -148,7 +156,9 @@ underlying ref, and shared its sematics</pre>
<pre id="var-usage">Usage: (build-source-cell name init)
</pre>
<pre id="var-docstr">Builds a source cell</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L231" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -157,7 +167,9 @@ underlying ref, and shared its sematics</pre>
<pre id="var-usage">Usage: (build-standard-cell name deps fun expr)
</pre>
<pre id="var-docstr">Builds a standard cell</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L292" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -166,7 +178,9 @@ underlying ref, and shared its sematics</pre>
<pre id="var-usage">Usage: (build-validator-cell deps fun expr)
</pre>
<pre id="var-docstr">Builds a validator cell</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L298" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -200,7 +214,9 @@ Or:
(throwf "%s must be greater than %s" ?fred ?sally))
Which will perform the validation</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L304" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -208,7 +224,9 @@ Which will perform the validation</pre>
<span id="var-type">multimethod</span><br />
<pre id="var-usage">No usage documentation available</pre>
<pre id="var-docstr">A 'readable' form of the cell</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L348" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -216,7 +234,9 @@ Which will perform the validation</pre>
<span id="var-type">multimethod</span><br />
<pre id="var-usage">No usage documentation available</pre>
<pre id="var-docstr">Evaluate a dataflow cell. Return [changed, old val]</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L372" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -225,7 +245,9 @@ Which will perform the validation</pre>
<pre id="var-usage">Usage: (get-cell df name)
</pre>
<pre id="var-docstr">Get the single cell named by name</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L94" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -234,7 +256,9 @@ Which will perform the validation</pre>
<pre id="var-usage">Usage: (get-cells df name)
</pre>
<pre id="var-docstr">Get all the cells named by name</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L89" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -243,7 +267,9 @@ Which will perform the validation</pre>
<pre id="var-usage">Usage: (get-old-value df env name)
</pre>
<pre id="var-docstr">Looks up an old value</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L136" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -252,7 +278,9 @@ Which will perform the validation</pre>
<pre id="var-usage">Usage: (get-source-cells df)
</pre>
<pre id="var-docstr">Returns a collection of source cells from the dataflow</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L108" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -263,7 +291,9 @@ Which will perform the validation</pre>
<pre id="var-docstr">Gets a value from the df matching the passed symbol.
Signals an error if the name is not present, or if it not a single
value.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L115" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -272,7 +302,9 @@ value.</pre>
<pre id="var-usage">Usage: (get-value-from-cell cell)
</pre>
<pre id="var-docstr">Given a cell, get its value</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L143" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -281,7 +313,9 @@ value.</pre>
<pre id="var-usage">Usage: (get-values df name)
</pre>
<pre id="var-docstr">Gets a collection of values from the df by name</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L126" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -290,7 +324,9 @@ value.</pre>
<pre id="var-usage">Usage: (print-dataflow df)
</pre>
<pre id="var-docstr">Prints a dataflow, one cell per line</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L199" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -299,7 +335,9 @@ value.</pre>
<pre id="var-usage">Usage: (remove-cells df cells)
</pre>
<pre id="var-docstr">Given a collection of cells, remove them from the dataflow.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L218" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -308,7 +346,9 @@ value.</pre>
<pre id="var-usage">Usage: (source-cell? cell)
</pre>
<pre id="var-docstr">Is this cell a source cell?</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L103" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -319,7 +359,9 @@ value.</pre>
<pre id="var-docstr">Given a dataflow, and a map of name-value pairs, update the
dataflow by binding the new values. Each name must be of a source
cell</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/dataflow.clj#L438" id="var-source">Source</a>
+
+
+
</div>