aboutsummaryrefslogtreecommitdiff
path: root/def-api.html
diff options
context:
space:
mode:
authorTom Faulhaber <git_net@infolace.com>2009-08-07 23:37:28 -0700
committerTom Faulhaber <git_net@infolace.com>2009-08-07 23:37:28 -0700
commite61d6780abaff6a750f56a75d6d68ebace0181df (patch)
treeb8ce82d1f6c04ec57e4a9b229a95d2285062ee0e /def-api.html
parent7dfd694e88d7248ee8050431b5ab4b570440eba2 (diff)
Updated documentation for commit 6dd2205627cd524894b1175da20ce9c5ac65aef7
Diffstat (limited to 'def-api.html')
-rw-r--r--def-api.html31
1 files changed, 15 insertions, 16 deletions
diff --git a/def-api.html b/def-api.html
index 0e4f0ccd..7cfb45be 100644
--- a/def-api.html
+++ b/def-api.html
@@ -34,7 +34,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="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="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="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="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="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="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="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>
@@ -85,15 +85,14 @@ namespace.
</div>
</div></div>
<div id="content-tag"><div><h1 id="overview">API for <span id="namespace-name">def</span></h1>
-by <span id="author">Stephen C. Gilardi</span><br />
+by <span id="author">Unknown</span><br />
<br />Usage:
<pre>
(ns your-namespace
(:require <span id="long-name">clojure.contrib.def</span>))
</pre><pre>
</pre><h2>Overview</h2>
-<pre id="namespace-docstr">def.clj provides variants of def that make including doc strings and
-making private definitions more succinct.</pre>
+<pre id="namespace-docstr"></pre>
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
@@ -106,7 +105,7 @@ making private definitions more succinct.</pre>
<pre id="var-docstr">Defines an alias for a var: a new var with the same root binding (if
any) and similar metadata. The metadata of the alias is its initial
metadata (as provided by def) merged into the metadata of the original.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/def.clj#L66" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/6dd2205627cd524894b1175da20ce9c5ac65aef7/src/clojure/contrib/def.clj#L66" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="def/defhinted">defhinted</h2>
@@ -116,7 +115,7 @@ metadata (as provided by def) merged into the metadata of the original.</pre>
<pre id="var-docstr">Defines a var with a type hint matching the class of the given
init. Be careful about using any form of 'def' or 'binding' to a
value of a different type. See <a href="http://paste.lisp.org/display/73344">http://paste.lisp.org/display/73344</a></pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/def.clj#L83" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/6dd2205627cd524894b1175da20ce9c5ac65aef7/src/clojure/contrib/def.clj#L83" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="def/defmacro-">defmacro-</h2>
@@ -124,7 +123,7 @@ value of a different type. See <a href="http://paste.lisp.org/display/73344">ht
<pre id="var-usage">Usage: (defmacro- name &amp; decls)
</pre>
<pre id="var-docstr">Same as defmacro but yields a private definition</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/def.clj#L39" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/6dd2205627cd524894b1175da20ce9c5ac65aef7/src/clojure/contrib/def.clj#L39" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="def/defn-memo">defn-memo</h2>
@@ -132,7 +131,7 @@ value of a different type. See <a href="http://paste.lisp.org/display/73344">ht
<pre id="var-usage">Usage: (defn-memo fn-name &amp; defn-stuff)
</pre>
<pre id="var-docstr">Just like defn, but memoizes the function using clojure.core/memoize</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/def.clj#L141" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/6dd2205627cd524894b1175da20ce9c5ac65aef7/src/clojure/contrib/def.clj#L141" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="def/defnk">defnk</h2>
@@ -145,7 +144,7 @@ an alternating sequence of keywords and defaults values is expected. The
values of the keyword arguments are available in the function body by
virtue of the symbol corresponding to the keyword (cf. :keys destructuring).
defnk accepts an optional docstring as well as an optional metadata map.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/def.clj#L120" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/6dd2205627cd524894b1175da20ce9c5ac65aef7/src/clojure/contrib/def.clj#L120" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="def/defonce-">defonce-</h2>
@@ -154,7 +153,7 @@ defnk accepts an optional docstring as well as an optional metadata map.</pre>
(defonce- name expr doc)
</pre>
<pre id="var-docstr">Same as defonce but yields a private definition</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/def.clj#L59" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/6dd2205627cd524894b1175da20ce9c5ac65aef7/src/clojure/contrib/def.clj#L59" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="def/defstruct-">defstruct-</h2>
@@ -162,7 +161,7 @@ defnk accepts an optional docstring as well as an optional metadata map.</pre>
<pre id="var-usage">Usage: (defstruct- name &amp; decls)
</pre>
<pre id="var-docstr">Same as defstruct but yields a private definition</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/def.clj#L54" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/6dd2205627cd524894b1175da20ce9c5ac65aef7/src/clojure/contrib/def.clj#L54" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="def/defunbound">defunbound</h2>
@@ -171,7 +170,7 @@ defnk accepts an optional docstring as well as an optional metadata map.</pre>
(defunbound name doc)
</pre>
<pre id="var-docstr">Defines an unbound var with optional doc string</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/def.clj#L32" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/6dd2205627cd524894b1175da20ce9c5ac65aef7/src/clojure/contrib/def.clj#L32" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="def/defunbound-">defunbound-</h2>
@@ -179,7 +178,7 @@ defnk accepts an optional docstring as well as an optional metadata map.</pre>
<pre id="var-usage">Usage: (defunbound- name &amp; decls)
</pre>
<pre id="var-docstr">Same as defunbound but yields a private definition</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/def.clj#L49" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/6dd2205627cd524894b1175da20ce9c5ac65aef7/src/clojure/contrib/def.clj#L49" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="def/defvar">defvar</h2>
@@ -189,7 +188,7 @@ defnk accepts an optional docstring as well as an optional metadata map.</pre>
(defvar name init doc)
</pre>
<pre id="var-docstr">Defines a var with an optional intializer and doc string</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/def.clj#L23" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/6dd2205627cd524894b1175da20ce9c5ac65aef7/src/clojure/contrib/def.clj#L23" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="def/defvar-">defvar-</h2>
@@ -197,7 +196,7 @@ defnk accepts an optional docstring as well as an optional metadata map.</pre>
<pre id="var-usage">Usage: (defvar- name &amp; decls)
</pre>
<pre id="var-docstr">Same as defvar but yields a private definition</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/def.clj#L44" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/6dd2205627cd524894b1175da20ce9c5ac65aef7/src/clojure/contrib/def.clj#L44" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="def/name-with-attributes">name-with-attributes</h2>
@@ -213,7 +212,7 @@ added to the name's metadata map and the map is removed from the
macro argument list. The return value is a vector containing the name
with its extended metadata map and the list of unprocessed macro
arguments.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/def.clj#L94" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/6dd2205627cd524894b1175da20ce9c5ac65aef7/src/clojure/contrib/def.clj#L94" id="var-source">Source</a>
</div>