[clojure-contrib commit] r933 - Auto-documentation for contrib version r932
codesite...@google.com
Date: Wed Jun 10 21:16:23 2009
New Revision: 933
Modified:
wiki/ApiDocIndex.json
wiki/ApiDocIndex.wiki
wiki/ConditionApiDoc.wiki
wiki/OverviewOfContrib.wiki
Log:
Auto-documentation for contrib version r932
Modified: wiki/ApiDocIndex.json
==============================================================================
--- wiki/ApiDocIndex.json (original)
+++ wiki/ApiDocIndex.json Wed Jun 10 21:16:23 2009
@@ -60,7 +60,7 @@
"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.\n\nBased on an idea from
Chouser:\nhttp://groups.google.com/group/clojure/browse_frm/thread/da1285c538f22bb5"},
+ "Flexible raising and handling of conditions. A condition is a
map\ncontaining:\n\n - keys and values specified as arguments to raise,
and\n - a stack trace at key :stack-trace.\n\nNote: requires AOT
compilation.\n\nBased on an idea from
Chouser:\nhttp://groups.google.com/group/clojure/browse_frm/thread/da1285c538f22bb5"},
{"source-url":
"http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition/Condition.clj",
"wiki-url":
@@ -929,23 +929,23 @@
"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#46",
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#61",
"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"]],
+ "arglists":[["dispatch-fn", "&", "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."},
+ "Executes body in a context in which raised conditions can be
handled.\n\n dispatch-fn accepts a raised condition (a map) and returns a
selector\n value used to choose a handler.\n\n Handlers are forms within
body:\n\n (handle key\n ...)\n\n If a condition is raised,
handler-case executes the body of the first\n handler whose key satisfies
(isa? selector key). If no handlers match,\n the condition is
re-raised.\n\n While a handler is running, *condition* is bound to the
condition being\n handled and *selector* is bound to to the value returned
by dispatch-fn\n that matched the handler's key."},
{"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#40",
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#52",
"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"},
+ "Raises a condition with the supplied mappings. With no arguments,\n
re-raises the current condition. (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 21:16:23 2009
@@ -332,7 +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...
+[ConditionApiDoc#handler-case handler-case] macro
condition Executes body in a context in which raised conditi...
[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>
@@ -534,7 +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...
+[ConditionApiDoc#raise raise] macro
condition Raises a condition with the supplied mappings. Wit...
[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/ConditionApiDoc.wiki
==============================================================================
--- wiki/ConditionApiDoc.wiki (original)
+++ wiki/ConditionApiDoc.wiki Wed Jun 10 21:16:23 2009
@@ -19,6 +19,7 @@
==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.
@@ -36,33 +37,34 @@
===handler-case===
====macro====
<pre>
-Usage: *(_handler-case_ dispatch-fn condition & body)*
+Usage: *(_handler-case_ dispatch-fn & 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.
+<pre> Executes body in a context in which raised conditions can be handled.
-The name specified by condition is bound to the condition within
-handlers.
+dispatch-fn accepts a raised condition (a map) and returns a selector
+value used to choose a handler.
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>
+If a condition is raised, handler-case executes the body of the first
+handler whose key satisfies (isa? selector key). If no handlers match,
+the condition is re-raised.
+
+While a handler is running, `*`condition`*` is bound to the condition being
+handled and `*`selector`*` is bound to to the value returned by dispatch-fn
+that matched the handler's key.</pre>
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#46
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]
+[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#61
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>
+<pre> Raises a condition with the supplied mappings. With no arguments,
+re-raises the current condition. (keyval `=`> key val)</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=raise+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
+[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#52
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 21:16:23 2009
@@ -113,6 +113,7 @@
<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.