[clojure-contrib commit] r939 - Auto-documentation for contrib version r938
codesite...@google.com
Date: Fri Jun 12 21:12:43 2009
New Revision: 939
Modified:
wiki/ApiDocIndex.json
wiki/ApiDocIndex.wiki
wiki/ConditionApiDoc.wiki
Log:
Auto-documentation for contrib version r938
Modified: wiki/ApiDocIndex.json
==============================================================================
--- wiki/ApiDocIndex.json (original)
+++ wiki/ApiDocIndex.json Fri Jun 12 21:12:43 2009
@@ -929,7 +929,7 @@
"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#52",
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#54",
"wiki-url":
"http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc#*_full-stack-traces_*",
"namespace":"clojure.contrib.condition",
@@ -937,7 +937,7 @@
"doc":
"Bind to true to include clojure.{core,lang,main} frames in stack\n
traces"},
{"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#64",
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#69",
"wiki-url":
"http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc#handler-case",
"namespace":"clojure.contrib.condition",
@@ -946,7 +946,7 @@
"doc":
"Executes body in a context where raised conditions can be
handled.\n\n dispatch-fn accepts a raised condition (a map) and returns a
selector\n used to choose a handler.\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, re-raises the\n condition.\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#104",
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#103",
"wiki-url":
"http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc#print-stack-trace",
"namespace":"clojure.contrib.condition",
@@ -955,14 +955,14 @@
"doc":
"Prints the stack trace for a condition. Skips frames for classes in\n
clojure.{core,lang,main} unless the *full-stack-traces* is bound to\n
logical true"},
{"source-url":
- "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#56",
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#58",
"wiki-url":
"http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc#raise",
"namespace":"clojure.contrib.condition",
"name":"raise",
- "arglists":[[], ["&", "keyvals"]],
+ "arglists":[[], ["m"], ["key", "val", "&", "keyvals"]],
"doc":
- "Raises a condition with the supplied mappings. With no arguments,\n
re-raises the current condition. (keyval => key val)"},
+ "Raises a condition. With no arguments, re-raises the current
condition.\n With one argument (a map), raises the argument. With two or
more\n arguments, raises a map with keys and values from the arguments."},
{"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 Fri Jun 12 21:12:43 2009
@@ -536,7 +536,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. Wit...
+[ConditionApiDoc#raise raise] macro
condition Raises a condition. With no arguments, re-raises t...
[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 Fri Jun 12 21:12:43 2009
@@ -39,7 +39,7 @@
<pre> Bind to true to include clojure.{core,lang,main} frames in stack
traces</pre>
-[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=*full-stack-traces*+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#54
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=*full-stack-traces*+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
----
===handler-case===
====macro====
@@ -64,7 +64,7 @@
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#64
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#69
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]
----
===print-stack-trace===
====function====
@@ -75,15 +75,17 @@
clojure.{core,lang,main} unless the `*`full-stack-traces`*` is bound to
logical true</pre>
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#104
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=print-stack-trace+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#103
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=print-stack-trace+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
----
===raise===
====macro====
<pre>
Usage: *(_raise_)
- (_raise_ & keyvals)*
+ (_raise_ m)
+ (_raise_ key val & keyvals)*
</pre>
-<pre> Raises a condition with the supplied mappings. With no arguments,
-re-raises the current condition. (keyval `=`> key val)</pre>
+<pre> Raises a condition. With no arguments, re-raises the current
condition.
+With one argument (a map), raises the argument. With two or more
+arguments, raises a map with keys and values from the arguments.</pre>
-[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#56
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#58
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]