diff options
author | Tom Faulhaber <git_net@infolace.com> | 2009-11-02 08:22:57 -0800 |
---|---|---|
committer | Tom Faulhaber <git_net@infolace.com> | 2009-11-02 08:22:57 -0800 |
commit | 4a2c1b961cbfba49120aad1b9b583c630765fb54 (patch) | |
tree | 1764a14425e536172c2798b814475011e996c3ee | |
parent | e264bdee1f996a5ff5c3af055b1cc50340959f65 (diff) |
Updated documentation for commit 6dff158bdec5f06c33877c6c6550699d5e08ca71
-rw-r--r-- | api-index.html | 1 | ||||
-rw-r--r-- | api-index.json | 25 | ||||
-rw-r--r-- | index.html | 4 | ||||
-rw-r--r-- | trace-api.html | 28 |
4 files changed, 41 insertions, 17 deletions
diff --git a/api-index.html b/api-index.html index 4e37fd06..5ac70285 100644 --- a/api-index.html +++ b/api-index.html @@ -241,6 +241,7 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="ns-utils-api.html#docs">docs</a><span id="line-content"> macro ns-utils Prints documentation for the public vars in a name... </span></span><span id="section-content"> <a href="monads-api.html#domonad">domonad</a><span id="line-content"> macro monads Monad comprehension. Takes the name of a monad, a ... </span></span><span id="section-content"> <a href="http.agent-api.html#done?">done?</a><span id="line-content"> function http.agent Returns true if the HTTP request/response has comp... +</span></span><span id="section-content"> <a href="trace-api.html#dotrace">dotrace</a><span id="line-content"> macro trace Given a sequence of function identifiers, evaluate... </span></span><span id="section-content"> <a href="str-utils2-api.html#drop">drop</a><span id="line-content"> function str-utils2 Drops first n characters from s. Returns an empty... </span></span><span id="section-content"> <a href="sql-api.html#drop-table">drop-table</a><span id="line-content"> function sql Drops a table on the open database connection give... </span></span></pre> diff --git a/api-index.json b/api-index.json index 3d18c792..3e425347 100644 --- a/api-index.json +++ b/api-index.json @@ -527,11 +527,11 @@ "doc": "Backwards-compatibility for clojure.contrib.test-is\n\nThe clojure.contrib.test-is library moved from Contrib into the\nClojure distribution as clojure.test.\n\nThis happened on or around clojure-contrib Git commit\n82cf0409d0fcb71be477ebfc4da18ee2128a2ad1 on June 25, 2009.\n\nThis file makes the clojure.test interface available under the old\nnamespace clojure.contrib.test-is.\n\nThis includes support for the old syntax of the 'are' macro.\n\nThis was suggested by Howard Lewis Ship in ticket #26, \nhttp://www.assembla.com/spaces/clojure-contrib/tickets/26"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj", + "http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj", "wiki-url": "http://richhickey.github.com/clojure-contrib/trace-api.html", "name":"clojure.contrib.trace", - "author":"Stuart Sierra", + "author":"Stuart Sierra, Michel Salim", "doc": "This file defines simple \"tracing\" macros to help you see what your\ncode is doing."}, {"source-url": @@ -5893,14 +5893,14 @@ "doc":"Runs body with *out* bound to the value of *test-out*.", "name":"with-test-out"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L40", + "http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj#L40", "wiki-url": "http://richhickey.github.com/clojure-contrib//trace-api.html#trace/*trace-depth*", "namespace":"clojure.contrib.trace", "doc":"Current stack depth of traced function calls.", "name":"*trace-depth*"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L75", + "http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj#L75", "wiki-url": "http://richhickey.github.com/clojure-contrib//trace-api.html#trace/deftrace", "namespace":"clojure.contrib.trace", @@ -5909,7 +5909,16 @@ "Use in place of defn; traces each call/return of this fn, including\narguments. Nested calls to deftrace'd functions will print a\ntree-like structure.", "name":"deftrace"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L50", + "http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj#L86", + "wiki-url": + "http://richhickey.github.com/clojure-contrib//trace-api.html#trace/dotrace", + "namespace":"clojure.contrib.trace", + "arglists":[["fns", "&", "exprs"]], + "doc": + "Given a sequence of function identifiers, evaluate the body\nexpressions in an environment in which the identifiers are bound to\nthe traced functions. Does not work on inlined functions,\nsuch as clojure.core/+", + "name":"dotrace"}, + {"source-url": + "http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj#L50", "wiki-url": "http://richhickey.github.com/clojure-contrib//trace-api.html#trace/trace", "namespace":"clojure.contrib.trace", @@ -5918,7 +5927,7 @@ "Sends name (optional) and value to the tracer function, then\nreturns value. May be wrapped around any expression without\naffecting the result.", "name":"trace"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L64", + "http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj#L64", "wiki-url": "http://richhickey.github.com/clojure-contrib//trace-api.html#trace/trace-fn-call", "namespace":"clojure.contrib.trace", @@ -5927,7 +5936,7 @@ "Traces a single call to a function f with args. 'name' is the\nsymbol name of the function.", "name":"trace-fn-call"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L59", + "http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj#L59", "wiki-url": "http://richhickey.github.com/clojure-contrib//trace-api.html#trace/trace-indent", "namespace":"clojure.contrib.trace", @@ -5935,7 +5944,7 @@ "doc":"Returns an indentation string based on *trace-depth*", "name":"trace-indent"}, {"source-url": - "http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L44", + "http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj#L44", "wiki-url": "http://richhickey.github.com/clojure-contrib//trace-api.html#trace/tracer", "namespace":"clojure.contrib.trace", @@ -1971,13 +1971,13 @@ This was suggested by Howard Lewis Ship in ticket #26, <br /> <hr /> <h2 id="trace">trace</h2> - by <span id="author">Stuart Sierra</span><br /> + by <span id="author">Stuart Sierra, Michel Salim</span><br /> <a href="trace-api.html" id="api-link">Detailed API documentation</a><br /> <pre id="namespace-docstr">This file defines simple "tracing" macros to help you see what your code is doing.</pre> Public variables and functions: - <span id="var-link"><a href="trace-api.html#trace/*trace-depth*" id="var-tag">*trace-depth*</a> </span><span id="var-link"><a href="trace-api.html#trace/deftrace" id="var-tag">deftrace</a> </span><span id="var-link"><a href="trace-api.html#trace/trace" id="var-tag">trace</a> </span><span id="var-link"><a href="trace-api.html#trace/trace-fn-call" id="var-tag">trace-fn-call</a> </span><span id="var-link"><a href="trace-api.html#trace/trace-indent" id="var-tag">trace-indent</a> </span><span id="var-link"><a href="trace-api.html#trace/tracer" id="var-tag">tracer</a> </span><br /> + <span id="var-link"><a href="trace-api.html#trace/*trace-depth*" id="var-tag">*trace-depth*</a> </span><span id="var-link"><a href="trace-api.html#trace/deftrace" id="var-tag">deftrace</a> </span><span id="var-link"><a href="trace-api.html#trace/dotrace" id="var-tag">dotrace</a> </span><span id="var-link"><a href="trace-api.html#trace/trace" id="var-tag">trace</a> </span><span id="var-link"><a href="trace-api.html#trace/trace-fn-call" id="var-tag">trace-fn-call</a> </span><span id="var-link"><a href="trace-api.html#trace/trace-indent" id="var-tag">trace-indent</a> </span><span id="var-link"><a href="trace-api.html#trace/tracer" id="var-tag">tracer</a> </span><br /> </div><div id="namespace-entry"> <br /> diff --git a/trace-api.html b/trace-api.html index 2386c831..f0b822b4 100644 --- a/trace-api.html +++ b/trace-api.html @@ -52,6 +52,8 @@ namespace. </div><div style="margin-left: 1em;" class="toc-entry"> <a href="#trace/deftrace">deftrace</a> </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#trace/dotrace">dotrace</a> + </div><div style="margin-left: 1em;" class="toc-entry"> <a href="#trace/trace">trace</a> </div><div style="margin-left: 1em;" class="toc-entry"> <a href="#trace/trace-fn-call">trace-fn-call</a> @@ -65,7 +67,7 @@ namespace. </div> </div></div> <div id="content-tag"><div><h1 id="overview">API for <span id="namespace-name">trace</span></h1> -by <span id="author">Stuart Sierra</span><br /> +by <span id="author">Stuart Sierra, Michel Salim</span><br /> <br />Usage: <pre> (ns your-namespace @@ -83,7 +85,7 @@ code is doing.</pre> <span id="var-type">var</span><br /> <pre id="var-usage"></pre> <pre id="var-docstr">Current stack depth of traced function calls.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L40" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj#L40" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -94,7 +96,19 @@ code is doing.</pre> <pre id="var-docstr">Use in place of defn; traces each call/return of this fn, including arguments. Nested calls to deftrace'd functions will print a tree-like structure.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L75" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj#L75" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="trace/dotrace">dotrace</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (dotrace fns & exprs) +</pre> + <pre id="var-docstr">Given a sequence of function identifiers, evaluate the body +expressions in an environment in which the identifiers are bound to +the traced functions. Does not work on inlined functions, +such as clojure.core/+</pre> + <a href="http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj#L86" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -106,7 +120,7 @@ tree-like structure.</pre> <pre id="var-docstr">Sends name (optional) and value to the tracer function, then returns value. May be wrapped around any expression without affecting the result.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L50" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj#L50" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -116,7 +130,7 @@ affecting the result.</pre> </pre> <pre id="var-docstr">Traces a single call to a function f with args. 'name' is the symbol name of the function.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L64" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj#L64" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -125,7 +139,7 @@ symbol name of the function.</pre> <pre id="var-usage">Usage: (trace-indent) </pre> <pre id="var-docstr">Returns an indentation string based on *trace-depth*</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L59" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj#L59" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -135,7 +149,7 @@ symbol name of the function.</pre> </pre> <pre id="var-docstr">This function is called by trace. Prints to standard output, but may be rebound to do anything you like. 'name' is optional.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L44" id="var-source">Source</a> + <a href="http://github.com/richhickey/clojure-contrib/blob/6dff158bdec5f06c33877c6c6550699d5e08ca71/src/clojure/contrib/trace.clj#L44" id="var-source">Source</a> </div> |