[clojure-contrib commit] r937 - Auto-documentation for contrib version r936
codesite...@google.com
Date: Thu Jun 11 15:37:31 2009
New Revision: 937
Modified:
wiki/ApiDocIndex.json
wiki/ApiDocIndex.wiki
wiki/ConditionApiDoc.wiki
wiki/OverviewOfContrib.wiki
Log:
Auto-documentation for contrib version r936
Modified: wiki/ApiDocIndex.json
==============================================================================
--- wiki/ApiDocIndex.json (original)
+++ wiki/ApiDocIndex.json Thu Jun 11 15:37:31 2009
@@ -929,29 +929,38 @@
"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#61",
+ "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#*_full-stack-traces_*",
+ "namespace":"clojure.contrib.condition",
+ "name":"*full-stack-traces*",
+ "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",
"wiki-url":
"http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc#handler-case",
"namespace":"clojure.contrib.condition",
"name":"handler-case",
"arglists":[["dispatch-fn", "&", "body"]],
"doc":
- "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."},
+ "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#100",
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#104",
"wiki-url":
"http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc#print-stack-trace",
"namespace":"clojure.contrib.condition",
"name":"print-stack-trace",
"arglists":[["condition"]],
- "doc":"Prints the stack trace for a condition"},
+ "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#52",
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/condition.clj#56",
"wiki-url":
"http://code.google.com/p/clojure-contrib/wiki/ClojureContribConditionApiDoc#raise",
"namespace":"clojure.contrib.condition",
"name":"raise",
- "arglists":[["&", "keyvals"]],
+ "arglists":[[], ["&", "keyvals"]],
"doc":
"Raises a condition with the supplied mappings. With no arguments,\n
re-raises the current condition. (keyval => key val)"},
{"source-url":
Modified: wiki/ApiDocIndex.wiki
==============================================================================
--- wiki/ApiDocIndex.wiki (original)
+++ wiki/ApiDocIndex.wiki Thu Jun 11 15:37:31 2009
@@ -258,6 +258,7 @@
</pre>
==F==
<pre>
+[ConditionApiDoc#*_full-stack-traces_* *full-stack-traces*]
var condition Bind to true to include
clojure.{core,lang,main} f...
[MiglayoutApiDoc#fahrenheit fahrenheit] function
miglayout.example Converts a Celsius temperature to Fahrenheit. Inpu...
[FcaseApiDoc#fcase fcase] macro
fcase Generic switch/case macro. 'fcase' is short for '...
[LazySeqsApiDoc#fibs fibs] function
lazy-seqs Returns a lazy sequence of all the Fibonacci numbe...
@@ -332,7 +333,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 raised conditi...
+[ConditionApiDoc#handler-case handler-case] macro
condition Executes body in a context where raised conditions...
[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>
@@ -508,7 +509,7 @@
[ReplLnApiDoc#print-repl-info print-repl-info] function
repl-ln Prints info about the current repl.
[SqlApiDoc#print-sql-exception print-sql-exception] function
sql.internal Prints the contents of an SQLException to stream.
[SqlApiDoc#print-sql-exception-chain print-sql-exception-chain]
function sql.internal Prints a chain of SQLExceptions to stream.
-[ConditionApiDoc#print-stack-trace print-stack-trace]
function condition Prints the stack trace for a condition.
+[ConditionApiDoc#print-stack-trace print-stack-trace]
function condition Prints the stack trace for a condition.
Skips fram...
[StacktraceApiDoc#print-stack-trace print-stack-trace]
function stacktrace Prints a Clojure-oriented stack trace of
tr, a Thr...
[ProfileApiDoc#print-summary print-summary] function
profile Prints a table of the results returned by summariz...
[TestIsApiDoc#print-tap-diagnostic print-tap-diagnostic]
function test-is.tap Prints a TAP diagnostic line. data is a
(possibly...
Modified: wiki/ConditionApiDoc.wiki
==============================================================================
--- wiki/ConditionApiDoc.wiki (original)
+++ wiki/ConditionApiDoc.wiki Thu Jun 11 15:37:31 2009
@@ -31,49 +31,59 @@
==Public Variables and Functions==
Shortcuts:
-[#handler-case handler-case] [#print-stack-trace print-stack-trace]
[#raise raise]
+[#*_full-stack-traces_* *full-stack-traces*] [#handler-case handler-case]
[#print-stack-trace print-stack-trace] [#raise raise]
----
+===`*`full-stack-traces`*`===
+====var====
+<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]
+----
===handler-case===
====macro====
<pre>
Usage: *(_handler-case_ dispatch-fn & body)*
</pre>
-<pre> Executes body in a context in which raised conditions can be handled.
+<pre> Executes body in a context where raised conditions can be handled.
dispatch-fn accepts a raised condition (a map) and returns a selector
-value used to choose a handler.
+used to choose a handler.
Handlers are forms within body:
(handle key
...)
-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.
+If a condition is raised, executes the body of the first handler whose
+key satisfies (isa? selector key). If no handlers match, re-raises the
+condition.
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#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]
+[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]
----
===print-stack-trace===
====function====
<pre>
Usage: *(_print-stack-trace_ condition)*
</pre>
-<pre> Prints the stack trace for a condition</pre>
+<pre> Prints the stack trace for a condition. Skips frames for classes in
+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#100
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#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]
----
===raise===
====macro====
<pre>
-Usage: *(_raise_ & keyvals)*
+Usage: *(_raise_)
+ (_raise_ & keyvals)*
</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#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]
+[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]
Modified: wiki/OverviewOfContrib.wiki
==============================================================================
--- wiki/OverviewOfContrib.wiki (original)
+++ wiki/OverviewOfContrib.wiki Thu Jun 11 15:37:31 2009
@@ -122,7 +122,7 @@
Based on an idea from Chouser:
http://groups.google.com/group/clojure/browse`_`frm/thread/da1285c538f22bb5</pre>
Public Variables and Functions:
-[ConditionApiDoc#handler-case handler-case]
[ConditionApiDoc#print-stack-trace print-stack-trace]
[ConditionApiDoc#raise raise]
+[ConditionApiDoc#*_full-stack-traces_* *full-stack-traces*]
[ConditionApiDoc#handler-case handler-case]
[ConditionApiDoc#print-stack-trace print-stack-trace]
[ConditionApiDoc#raise raise]
----
===condt===