diff options
| author | Tom Faulhaber <git_net@infolace.com> | 2010-02-19 11:26:52 -0800 |
|---|---|---|
| committer | Tom Faulhaber <git_net@infolace.com> | 2010-02-19 11:26:52 -0800 |
| commit | 78b132edfc56eff93162e9cd264396528dc6df2d (patch) | |
| tree | 6592815e8d5ef8b4d4ef76593f4b335ed23d734d /branch-1.1.x/def-api.html | |
| parent | cc1f8c119fbf973bc75bd25ba329a8b1c0d0ece7 (diff) | |
Document the latest branches, et al., in clojure-contrib. Supporting docs currently missing.
Diffstat (limited to 'branch-1.1.x/def-api.html')
| -rw-r--r-- | branch-1.1.x/def-api.html | 245 |
1 files changed, 245 insertions, 0 deletions
diff --git a/branch-1.1.x/def-api.html b/branch-1.1.x/def-api.html new file mode 100644 index 00000000..14a093df --- /dev/null +++ b/branch-1.1.x/def-api.html @@ -0,0 +1,245 @@ +<html> + <head> + <title>def API reference (clojure-contrib)</title> + <link href="../static/favicon.png" rel="icon" /> + <link href="../static/favicon.png" rel="shortcut icon" /> + <link media="all" type="text/css" href="../static/clojure.css" rel="stylesheet" /> + <link media="all" type="text/css" href="../static/wiki.css" rel="stylesheet" /> + <link media="all" type="text/css" href="../static/internal.css" rel="stylesheet" /> + <!-- TODO: are we using these (from clojure.org)? If so, add the files --> + <script src="file/view/code_highlighter.js" type="text/javascript"></script> + <script src="file/view/clojure.js" type="text/javascript"></script> + <style>.menuWrapper{height: 36px;}</style> + <!--[if lte IE 6]> + <link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" /> + <![endif]--> + </head> +<!-- +This document was auto-generated from the source by the clojure autodoc system. +To report errors or ask questions about the overall documentation structure, formatting, +etc., contact Tom Faulhaber (google mail name: tomfaulhaber). +For errors in the documentation of a particular namespace, contact the author of that +namespace. +--> + <body> + <div id="AllContentContainer"> + <div id="Header"> + <a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="../static/clojure-icon.gif" /></a> + <h1><a title="page header title" id="page-header" href="index.html">Clojure-contrib API Reference</a></h1> + </div> + <div id="leftcolumn"><div style="text-align: center;"></div> +<div class="menu"> + <div class="WikiCustomNav WikiElement wiki"> + <div class="BranchTOC"> + <a class="wiki_link" href="#">Branches</a> + <ul id="left-sidebar-branch-list"> + <li><a href="../index.html" class="wiki_link">master</a></li><li><a href="../branch-1.1.x/index.html" class="wiki_link">1.1.x</a></li> + </ul> + </div> + <a class="wiki_link" href="index.html">Overview</a><br /> + <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="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="io-api.html" class="wiki_link">io</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json-api.html" class="wiki_link">json</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="properties-api.html" class="wiki_link">properties</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="reflect-api.html" class="wiki_link">reflect</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-api.html" class="wiki_link">seq</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-api.html" class="wiki_link">shell</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="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="string-api.html" class="wiki_link">string</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> +</div> + <div id="rightcolumn"> + <div id="Content"> + <div class="contentBox"><div class="innerContentBox"> + <div id="content_view" class="wiki wikiPage"> + <div id="right-sidebar"><div id="toc"> + <h1 class="nopad">Table of Contents</h1> + <div style="margin-left: 1em;" class="toc-section"> + <a href="#toc0">Overview</a> + <div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.def/defalias">defalias</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.def/defhinted">defhinted</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.def/defmacro-">defmacro-</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.def/defn-memo">defn-memo</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.def/defnk">defnk</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.def/defonce-">defonce-</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.def/defstruct-">defstruct-</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.def/defunbound">defunbound</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.def/defunbound-">defunbound-</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.def/defvar">defvar</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.def/defvar-">defvar-</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.def/name-with-attributes">name-with-attributes</a> + </div> + <br /> + </div> +</div> +</div> + <div id="content-tag"><h1 id="overview">API for <span id="namespace-name">def</span> + <span id="branch-name">(1.1.x branch)</span></h1> +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"></pre> +<br /> +<h2>Public Variables and Functions</h2> +<div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.def/defalias">defalias</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (defalias name orig) + (defalias name orig doc) +</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/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L66" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.def/defhinted">defhinted</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (defhinted sym init) +</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/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L83" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.def/defmacro-">defmacro-</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (defmacro- name & decls) +</pre> + <pre id="var-docstr">Same as defmacro but yields a private definition</pre> + <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L39" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.def/defn-memo">defn-memo</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (defn-memo fn-name & 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/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L141" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.def/defnk">defnk</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (defnk fn-name & fn-tail) +</pre> + <pre id="var-docstr">Define a function accepting keyword arguments. Symbols up to the first +keyword in the parameter list are taken as positional arguments. Then +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/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L120" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.def/defonce-">defonce-</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (defonce- name expr) + (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/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L59" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.def/defstruct-">defstruct-</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (defstruct- name & decls) +</pre> + <pre id="var-docstr">Same as defstruct but yields a private definition</pre> + <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L54" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.def/defunbound">defunbound</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (defunbound name) + (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/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L32" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.def/defunbound-">defunbound-</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (defunbound- name & decls) +</pre> + <pre id="var-docstr">Same as defunbound but yields a private definition</pre> + <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L49" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.def/defvar">defvar</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (defvar name) + (defvar name init) + (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/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L23" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.def/defvar-">defvar-</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (defvar- name & decls) +</pre> + <pre id="var-docstr">Same as defvar but yields a private definition</pre> + <a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L44" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.def/name-with-attributes">name-with-attributes</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (name-with-attributes name macro-args) +</pre> + <pre id="var-docstr">To be used in macro definitions. +Handles optional docstrings and attribute maps for a name to be defined +in a list of macro arguments. If the first macro argument is a string, +it is added as a docstring to name and removed from the macro argument +list. If afterwards the first macro argument is a map, its entries are +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/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/def.clj#L94" id="var-source">Source</a> +</div> + + +</div> + </div> + </div> + </div> + </div> + <div id="foot"> + <div style="text-align: center;" id="copyright">Copyright 2007-2009 by Rich Hickey and the various contributors</div> + </div> + </div> + <div id="DesignedBy">Logo & site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br /> + Clojure auto-documentation system by Tom Faulhaber.</div> + </div> + <!-- /AllContentContainer --> + </body> + +</html>
\ No newline at end of file |