diff options
author | Tom Faulhaber <git_net@infolace.com> | 2010-04-30 16:19:00 -0700 |
---|---|---|
committer | Tom Faulhaber <git_net@infolace.com> | 2010-04-30 16:19:00 -0700 |
commit | 4a3f270f93c687ec29f9cdd178f22b9fd3d82e37 (patch) | |
tree | cbe8efecfd3a0aab290cb6b7c2eec2135385d52a /branch-1.1.x/logging-api.html | |
parent | ae92eda353beed7ff5ee07ea80491d7c7bca110c (diff) |
Manual autodoc update (mostly whitespace diffs caused by new tags, not yet used).
Diffstat (limited to 'branch-1.1.x/logging-api.html')
-rw-r--r-- | branch-1.1.x/logging-api.html | 84 |
1 files changed, 63 insertions, 21 deletions
diff --git a/branch-1.1.x/logging-api.html b/branch-1.1.x/logging-api.html index a5412d49..06130fbd 100644 --- a/branch-1.1.x/logging-api.html +++ b/branch-1.1.x/logging-api.html @@ -40,7 +40,7 @@ namespace. <a class="wiki_link" href="api-index.html">API Index</a><br /> <a class="wiki_link" href="#">Namespaces:</a> <ul id="left-sidebar-list"> - <li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="apply-macro-api.html" class="wiki_link">apply-macro</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="duck-streams-api.html" class="wiki_link">duck-streams</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="javadoc.browse-api.html" class="wiki_link">javadoc.browse</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json.read-api.html" class="wiki_link">json.read</a></li><li><a href="json.write-api.html" class="wiki_link">json.write</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="pprint-api.html" class="wiki_link">pprint</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-utils-api.html" class="wiki_link">seq-utils</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="shell-out-api.html" class="wiki_link">shell-out</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li> + <li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="apply-macro-api.html" class="wiki_link">apply-macro</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="duck-streams-api.html" class="wiki_link">duck-streams</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json.read-api.html" class="wiki_link">json.read</a></li><li><a href="json.write-api.html" class="wiki_link">json.write</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="pprint-api.html" class="wiki_link">pprint</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-utils-api.html" class="wiki_link">seq-utils</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="shell-out-api.html" class="wiki_link">shell-out</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li> </ul> </div> </div> @@ -139,6 +139,8 @@ You can redirect all java writes of System.out and System.err to the log system by calling log-capture!. To rebind *out* and *err* to the log system invoke with-logs. In both cases a log-ns (e.g., "com.example.captured") needs to be specified to namespace the output.</pre> + + <br /> <h2>Public Variables and Functions</h2> <div id="var-entry"> @@ -149,7 +151,9 @@ needs to be specified to namespace the output.</pre> <pre id="var-usage"></pre> <pre id="var-docstr">A boolean indicating whether direct logging (as opposed to via an agent) is allowed when not operating from within a transaction. Defaults to true.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L202" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -157,7 +161,9 @@ allowed when not operating from within a transaction. Defaults to true.</pre> <span id="var-type">var</span><br /> <pre id="var-usage"></pre> <pre id="var-docstr">The name of the logging implementation used.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L190" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -166,7 +172,9 @@ allowed when not operating from within a transaction. Defaults to true.</pre> <pre id="var-usage"></pre> <pre id="var-docstr">The default agent used for performing logging durng a transaction or when direct logging is disabled.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L196" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -176,7 +184,9 @@ direct logging is disabled.</pre> </pre> <pre id="var-docstr">Writes the message immediately, and ignores the first argument. Used by the logging agent. End-users should never need to call this function.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L208" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -186,7 +196,9 @@ logging agent. End-users should never need to call this function.</pre> (debug message throwable) </pre> <pre id="var-docstr">Logs a message at the debug level.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L316" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -198,7 +210,9 @@ logging agent. End-users should never need to call this function.</pre> <pre id="var-docstr">Returns true if the specific logging level is enabled. Use of this function should only be necessary if one needs to execute alternate code paths beyond whether the log should be written to.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L232" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -208,7 +222,9 @@ whether the log should be written to.</pre> (error message throwable) </pre> <pre id="var-docstr">Logs a message at the error level.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L337" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -218,7 +234,9 @@ whether the log should be written to.</pre> (fatal message throwable) </pre> <pre id="var-docstr">Logs a message at the fatal level.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L344" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -227,7 +245,9 @@ whether the log should be written to.</pre> <pre id="var-usage"></pre> <pre id="var-docstr">Implementation-specific check if a particular level is enabled. End-users should not need to call this function.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L190" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -236,7 +256,9 @@ should not need to call this function.</pre> <pre id="var-usage"></pre> <pre id="var-docstr">Returns an implementation-specific log by string namespace. End-users should not need to call this function.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L190" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -245,7 +267,9 @@ not need to call this function.</pre> <pre id="var-usage"></pre> <pre id="var-docstr">Implementation-specific write of a log message. End-users should not need to call this function.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L190" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -255,7 +279,9 @@ call this function.</pre> (info message throwable) </pre> <pre id="var-docstr">Logs a message at the info level.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L323" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -267,7 +293,9 @@ call this function.</pre> </pre> <pre id="var-docstr">Logs a message, either directly or via an agent. Also see the level-specific convenience macros.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L215" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -279,7 +307,9 @@ convenience macros.</pre> to :info and :error logging, respectively. The specified log-ns value will be used to namespace all redirected logging. NOTE: this will not redirect output of *out* or *err*; for that, use with-logs.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L271" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -289,7 +319,9 @@ output of *out* or *err*; for that, use with-logs.</pre> </pre> <pre id="var-docstr">Creates a PrintStream that will output to the log. End-users should not need to invoke this function.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L249" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -298,7 +330,9 @@ to invoke this function.</pre> <pre id="var-usage">Usage: (log-uncapture!) </pre> <pre id="var-docstr">Restores System.out and System.err to their original values.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L287" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -308,7 +342,9 @@ to invoke this function.</pre> </pre> <pre id="var-docstr">Evaluates expr and outputs the form and its result to the debug log; returns the result of expr.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L242" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -318,7 +354,9 @@ the result of expr.</pre> (trace message throwable) </pre> <pre id="var-docstr">Logs a message at the trace level.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L309" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -328,7 +366,9 @@ the result of expr.</pre> (warn message throwable) </pre> <pre id="var-docstr">Logs a message at the warn level.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L330" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -339,7 +379,9 @@ the result of expr.</pre> <pre id="var-docstr">Evaluates exprs in a context in which *out* and *err* are bound to :info and :error logging, respectively. The specified log-ns value will be used to namespace all redirected logging.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cd69d778f5a08810d4b934dbfc08f400ed34146a/src/clojure/contrib/logging.clj#L297" id="var-source">Source</a> + + + </div> |