luciano/specter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add api docs

Browse source
This commit is contained in:
Nathan Marz 2016-06-02 12:03:15 -04:00 committed by nathanmarz
parent b5d65fda55
commit 22e3ddab00
6 changed files with 131 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
com.rpl.specter.defhelpers.html Normal file
View file

@ -0,0 +1,3 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><link href="css/default.css" rel="stylesheet" type="text/css" /><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>com.rpl.specter.defhelpers documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Specter</span> <span class="project-version">0.11.1-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>com</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rpl</span></div></div></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>specter</span></div></div></li><li class="depth-4 branch current"><a href="com.rpl.specter.defhelpers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>defhelpers</span></div></a></li><li class="depth-4 branch"><a href="com.rpl.specter.macros.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>macros</span></div></a></li><li class="depth-4"><a href="com.rpl.specter.prot-opt-invoke.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>prot-opt-invoke</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="com.rpl.specter.defhelpers.html#var-define-ParamsNeededPath"><div class="inner"><span>define-ParamsNeededPath</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.defhelpers.html#var-gensyms"><div class="inner"><span>gensyms</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">com.rpl.specter.defhelpers</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-define-ParamsNeededPath"><h3>define-ParamsNeededPath</h3><h4 class="type">macro</h4><div class="usage"><code>(define-ParamsNeededPath clj? fn-type invoke-name var-arity-impl)</code></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/clj/com/rpl/specter/defhelpers.clj#L6">view source</a></div></div><div class="public anchor" id="var-gensyms"><h3>gensyms</h3><div class="usage"><code>(gensyms amt)</code></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/clj/com/rpl/specter/defhelpers.clj#L3">view source</a></div></div></div></body></html>

85
com.rpl.specter.html Normal file
View file

File diff suppressed because one or more lines are too long

22
com.rpl.specter.macros.html Normal file
View file

File diff suppressed because one or more lines are too long

3
com.rpl.specter.prot-opt-invoke.html Normal file
View file

@ -0,0 +1,3 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><link href="css/default.css" rel="stylesheet" type="text/css" /><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>com.rpl.specter.prot-opt-invoke documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Specter</span> <span class="project-version">0.11.1-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>com</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rpl</span></div></div></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>specter</span></div></div></li><li class="depth-4 branch"><a href="com.rpl.specter.defhelpers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>defhelpers</span></div></a></li><li class="depth-4 branch"><a href="com.rpl.specter.macros.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>macros</span></div></a></li><li class="depth-4 current"><a href="com.rpl.specter.prot-opt-invoke.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>prot-opt-invoke</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="com.rpl.specter.prot-opt-invoke.html#var-mk-optimized-invocation"><div class="inner"><span>mk-optimized-invocation</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">com.rpl.specter.prot-opt-invoke</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-mk-optimized-invocation"><h3>mk-optimized-invocation</h3><h4 class="type">macro</h4><div class="usage"><code>(mk-optimized-invocation protocol obj method num-args)</code></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/clj/com/rpl/specter/prot_opt_invoke.clj#L3">view source</a></div></div></div></body></html>

15
com.rpl.specter.zipper.html Normal file
View file

@ -0,0 +1,15 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><link href="css/default.css" rel="stylesheet" type="text/css" /><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>com.rpl.specter.zipper documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Specter</span> <span class="project-version">0.11.1-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>com</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rpl</span></div></div></li><li class="depth-3"><a href="com.rpl.specter.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>specter</span></div></a></li><li class="depth-4 branch"><a href="com.rpl.specter.macros.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>macros</span></div></a></li><li class="depth-4 current"><a href="com.rpl.specter.zipper.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>zipper</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-DOWN"><div class="inner"><span>DOWN</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-find-first"><div class="inner"><span>find-first</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-INNER-LEFT"><div class="inner"><span>INNER-LEFT</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-INNER-RIGHT"><div class="inner"><span>INNER-RIGHT</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-LEFT"><div class="inner"><span>LEFT</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-LEFTMOST"><div class="inner"><span>LEFTMOST</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-NEXT"><div class="inner"><span>NEXT</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-NEXT-WALK"><div class="inner"><span>NEXT-WALK</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-NODE"><div class="inner"><span>NODE</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-NODE-SEQ"><div class="inner"><span>NODE-SEQ</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-PREV"><div class="inner"><span>PREV</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-RIGHT"><div class="inner"><span>RIGHT</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-RIGHTMOST"><div class="inner"><span>RIGHTMOST</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-SEQ-ZIP"><div class="inner"><span>SEQ-ZIP</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-UP"><div class="inner"><span>UP</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-VECTOR-ZIP"><div class="inner"><span>VECTOR-ZIP</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-XML-ZIP"><div class="inner"><span>XML-ZIP</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.zipper.html#var-zipper"><div class="inner"><span>zipper</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">com.rpl.specter.zipper</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-DOWN"><h3>DOWN</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L57">view source</a></div></div><div class="public anchor" id="var-find-first"><h3>find-first</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigate the zipper to the first element
in the structure matching predfn. A linear scan
is done using NEXT to find the element.</pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L119">view source</a></div></div><div class="public anchor" id="var-INNER-LEFT"><h3>INNER-LEFT</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigate to the empty subsequence directly to the
left of this element.</pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L88">view source</a></div></div><div class="public anchor" id="var-INNER-RIGHT"><h3>INNER-RIGHT</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigate to the empty subsequence directly to the
right of this element.</pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L79">view source</a></div></div><div class="public anchor" id="var-LEFT"><h3>LEFT</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigate to the element to the left.
If no element there, works like STOP.</pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L53">view source</a></div></div><div class="public anchor" id="var-LEFTMOST"><h3>LEFTMOST</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L65">view source</a></div></div><div class="public anchor" id="var-NEXT"><h3>NEXT</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigate to the next element in the structure.
If no next element, works like STOP.</pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L23">view source</a></div></div><div class="public anchor" id="var-NEXT-WALK"><h3>NEXT-WALK</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigate to every element reachable using calls
to NEXT</pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L130">view source</a></div></div><div class="public anchor" id="var-NODE"><h3>NODE</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L97">view source</a></div></div><div class="public anchor" id="var-NODE-SEQ"><h3>NODE-SEQ</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigate to the subsequence containing only
the node currently pointed to. This works just
like srange and can be used to remove elements
from the structure</pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L105">view source</a></div></div><div class="public anchor" id="var-PREV"><h3>PREV</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigate to the previous element.
If this is the first element, works like STOP.</pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L60">view source</a></div></div><div class="public anchor" id="var-RIGHT"><h3>RIGHT</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigate to the element to the right.
If no element there, works like STOP.</pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L49">view source</a></div></div><div class="public anchor" id="var-RIGHTMOST"><h3>RIGHTMOST</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L64">view source</a></div></div><div class="public anchor" id="var-SEQ-ZIP"><h3>SEQ-ZIP</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L19">view source</a></div></div><div class="public anchor" id="var-UP"><h3>UP</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L58">view source</a></div></div><div class="public anchor" id="var-VECTOR-ZIP"><h3>VECTOR-ZIP</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L18">view source</a></div></div><div class="public anchor" id="var-XML-ZIP"><h3>XML-ZIP</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L20">view source</a></div></div><div class="public anchor" id="var-zipper"><h3>zipper</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/foo/bar/blob/master/src/com/rpl/specter/zipper.cljx#L11">view source</a></div></div></div></body></html>

3
index.html Normal file
View file

File diff suppressed because one or more lines are too long