[clojure-contrib commit] r929 - Auto-documentation for contrib version r928
codesite...@google.com
Date: Wed Jun 10 00:20:05 2009
New Revision: 929
Added:
wiki/ConditionApiDoc.wiki
Modified:
wiki/ApiDocIndex.json
wiki/ApiDocIndex.wiki
wiki/ApiDocSidebar.wiki
wiki/OverviewOfContrib.wiki
Log:
Auto-documentation for contrib version r928
Modified: wiki/ApiDocIndex.json
==============================================================================
--- wiki/ApiDocIndex.json (original)
+++ wiki/ApiDocIndex.json Wed Jun 10 00:20:05 2009
@@ -54,6 +54,24 @@
"author":"Stephen C. Gilardi",
"doc":"Extensions to the basic cond function."},
{"source-url":
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj",
+ "wiki-url":
+ "http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc",
+ "name":"clojure.contrib.condition",
+ "author":"Stephen C. Gilardi",
+ "doc":
+ "Flexible raising and handling of conditions. A condition is a
map\ncontaining:\n - keys and values specified as arguments to raise,
and\n - a stack trace at key :stack-trace.\n\nNote: requires AOT
compilation."},
+ {"source-url":
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition/Condition.clj",
+ "wiki-url":
+ "http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionConditionApiDoc",
+ "name":"clojure.contrib.condition.Condition"},
+ {"source-url":
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition/example.clj",
+ "wiki-url":
+ "http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionExampleApiDoc",
+ "name":"clojure.contrib.condition.example"},
+ {"source-url":
"http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condt.clj",
"wiki-url":
"http://code.google.com/p/clojure-contrib/wiki/ClojureContribCondtApiDoc",
@@ -910,6 +928,24 @@
"arglists":[["bindings", "&", "clauses"]],
"doc":
"Takes a binding-form and a set of test/expr pairs. Evaluates each
test\n one at a time. If a test returns logical true, cond-let evaluates
and\n returns expr with binding-form bound to the value of test and
doesn't\n evaluate any of the other tests or exprs. To provide a default
value\n either provide a literal that evaluates to logical true and is\n
binding-compatible with binding-form, or use :else as the test and don't\n
refer to any parts of binding-form in the expr. (cond-let binding-form)\n
returns nil."},
+ {"source-url":
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#40",
+ "wiki-url":
+ "http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc#handler-case",
+ "namespace":"clojure.contrib.condition",
+ "name":"handler-case",
+ "arglists":[["dispatch-fn", "condition", "&", "body"]],
+ "doc":
+ "Executes body in a context in which any raised conditions can be
handled.\n\n dispatch-fn accepts a raised condition: a map, and returns a
value used\n to select a handler.\n\n The name specified by condition is
bound to the condition within\n handlers.\n\n Handlers are forms within
body:\n\n (handle key\n ...)\n\n If a condition is raised,
executes the body of the first handler whose\n key satisfies (isa?
selector key). If no handlers match, the condition is\n re-raised."},
+ {"source-url":
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#34",
+ "wiki-url":
+ "http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc#raise",
+ "namespace":"clojure.contrib.condition",
+ "name":"raise",
+ "arglists":[["&", "keyvals"]],
+ "doc":
+ "Raises a condition with the supplied mappings.\n keyval => key val"},
{"source-url":
"http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condt.clj#31",
"wiki-url":
Modified: wiki/ApiDocIndex.wiki
==============================================================================
--- wiki/ApiDocIndex.wiki (original)
+++ wiki/ApiDocIndex.wiki Wed Jun 10 00:20:05 2009
@@ -332,6 +332,7 @@
[PprintApiDoc#*_html-compatible_* *html-compatible*]
var pprint.examples.xml If true, empty tags will have a space
before the ...
[PrxmlApiDoc#*_html-compatible_* *html-compatible*]
var prxml If true, empty tags will have a space
before the c...
[ErrorKitApiDoc#handle handle] function
error-kit Special form to be used inside a 'with-handler'. ...
+[ConditionApiDoc#handler-case handler-case] macro
condition Executes body in a context in which any raised con...
[HttpAgentApiDoc#http-agent http-agent] function
http.agent Creates (and immediately returns) an Agent represe...
[HttpConnectionApiDoc#http-connection http-connection]
function http.connection Opens an HttpURLConnection at the URL,
handled by ...
</pre>
@@ -533,6 +534,7 @@
==R==
<pre>
[ReplUtilsApiDoc#*_remote-javadocs_* *remote-javadocs*]
var repl-utils Ref to a map from package name prefixes to
URLs fo...
+[ConditionApiDoc#raise raise] macro
condition Raises a condition with the supplied mappings. k...
[ErrorKitApiDoc#raise raise] macro
error-kit Raise an error of the type err-name, constructed w...
[ErrorKitApiDoc#raise_* raise*] function
error-kit Raise the given error object, best if created by a...
[SeqUtilsApiDoc#rand-elt rand-elt] function
seq-utils Return a random element of this seq.
Modified: wiki/ApiDocSidebar.wiki
==============================================================================
--- wiki/ApiDocSidebar.wiki (original)
+++ wiki/ApiDocSidebar.wiki Wed Jun 10 00:20:05 2009
@@ -17,6 +17,7 @@
[CommandLineApiDoc command-line]<br/>
[ComplexNumbersApiDoc complex-numbers]<br/>
[CondApiDoc cond]<br/>
+[ConditionApiDoc condition]<br/>
[CondtApiDoc condt]<br/>
[CoreApiDoc core]<br/>
[DataflowApiDoc dataflow]<br/>
Added: wiki/ConditionApiDoc.wiki
==============================================================================
--- (empty file)
+++ wiki/ConditionApiDoc.wiki Wed Jun 10 00:20:05 2009
@@ -0,0 +1,65 @@
+#summary condition API Reference
+#sidebar ApiDocSidebar
+
+<wiki:comment>
+This document was auto-generated from the clojure.contrib source by
contrib-autodoc.
+To report errors or ask questions about the overall documentation
structure, formatting,
+etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
+For errors in the documentation of a particular namespace, contact the
author of that
+namespace.
+</wiki:comment>
+=API for condition=
+by Stephen C. Gilardi
+
+Usage:
+{{{
+(ns <your-namespace>
+ (:require clojure.contrib.condition))
+}}}
+==Overview==
+<pre> Flexible raising and handling of conditions. A condition is a map
+containing:
+ - keys and values specified as arguments to raise, and
+ - a stack trace at key :stack-trace.
+
+Note: requires AOT compilation.</pre>
+
+
+==Public Variables and Functions==
+Shortcuts:
+[#handler-case handler-case] [#raise raise]
+
+----
+===handler-case===
+====macro====
+<pre>
+Usage: *(_handler-case_ dispatch-fn condition & body)*
+</pre>
+<pre> Executes body in a context in which any raised conditions can be
handled.
+
+dispatch-fn accepts a raised condition: a map, and returns a value used
+to select a handler.
+
+The name specified by condition is bound to the condition within
+handlers.
+
+Handlers are forms within body:
+
+ (handle key
+ ...)
+
+If a condition is raised, executes the body of the first handler whose
+key satisfies (isa? selector key). If no handlers match, the condition is
+re-raised.</pre>
+
+[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#40
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=handler-case+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
+----
+===raise===
+====macro====
+<pre>
+Usage: *(_raise_ & keyvals)*
+</pre>
+<pre> Raises a condition with the supplied mappings.
+keyval `=`> key val</pre>
+
+[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#34
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=raise+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
Modified: wiki/OverviewOfContrib.wiki
==============================================================================
--- wiki/OverviewOfContrib.wiki (original)
+++ wiki/OverviewOfContrib.wiki Wed Jun 10 00:20:05 2009
@@ -107,6 +107,20 @@
[CondApiDoc#cond-let cond-let]
----
+===condition===
+by Stephen C. Gilardi<br>
+API Overview [ConditionApiDoc here]
+
+<pre> Flexible raising and handling of conditions. A condition is a map
+containing:
+ - keys and values specified as arguments to raise, and
+ - a stack trace at key :stack-trace.
+
+Note: requires AOT compilation.</pre>
+Public Variables and Functions:
+[ConditionApiDoc#handler-case handler-case] [ConditionApiDoc#raise raise]
+
+----
===condt===
by Stuart Sierra<br>
API Overview [CondtApiDoc here]