update docs
This commit is contained in:
Nathan Marz
nathanmarz
parent
040b676492
commit
621c483859
6 changed files with 148 additions and 97 deletions
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,3 +1,12 @@
|
|||
<!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.protocols 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.2</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 branch current"><a href="com.rpl.specter.protocols.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>protocols</span></div></a></li><li class="depth-4 branch"><a href="com.rpl.specter.transients.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>transients</span></div></a></li><li class="depth-4"><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.protocols.html#var-Collector"><div class="inner"><span>Collector</span></div></a></li><li class="depth-2"><a href="com.rpl.specter.protocols.html#var-collect-val"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>collect-val</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.protocols.html#var-Navigator"><div class="inner"><span>Navigator</span></div></a></li><li class="depth-2 branch"><a href="com.rpl.specter.protocols.html#var-select*"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>select*</span></div></a></li><li class="depth-2"><a href="com.rpl.specter.protocols.html#var-transform*"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>transform*</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">com.rpl.specter.protocols</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-Collector"><h3>Collector</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-collect-val"><h3>collect-val</h3><div class="usage"><code>(collect-val this structure)</code></div><div class="doc"><pre class="plaintext"></pre></div></div></div></div><div class="src-link"><a href="https://github.com/nathanmarz/specter/tree/0.11.2/src/clj/com/rpl/specter/protocols.cljx#L7">view source</a></div></div><div class="public anchor" id="var-Navigator"><h3>Navigator</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-select*"><h3>select*</h3><div class="usage"><code>(select* this structure next-fn)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-transform*"><h3>transform*</h3><div class="usage"><code>(transform* this structure next-fn)</code></div><div class="doc"><pre class="plaintext"></pre></div></div></div></div><div class="src-link"><a href="https://github.com/nathanmarz/specter/tree/0.11.2/src/clj/com/rpl/specter/protocols.cljx#L3">view source</a></div></div></div></body></html>
|
||||
<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.protocols 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.12.0</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 branch current"><a href="com.rpl.specter.protocols.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>protocols</span></div></a></li><li class="depth-4 branch"><a href="com.rpl.specter.transients.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>transients</span></div></a></li><li class="depth-4"><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.protocols.html#var-Collector"><div class="inner"><span>Collector</span></div></a></li><li class="depth-2"><a href="com.rpl.specter.protocols.html#var-collect-val"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>collect-val</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.protocols.html#var-Navigator"><div class="inner"><span>Navigator</span></div></a></li><li class="depth-2 branch"><a href="com.rpl.specter.protocols.html#var-select*"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>select*</span></div></a></li><li class="depth-2"><a href="com.rpl.specter.protocols.html#var-transform*"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>transform*</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">com.rpl.specter.protocols</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-Collector"><h3>Collector</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-collect-val"><h3>collect-val</h3><div class="usage"><code>(collect-val this structure)</code></div><div class="doc"><pre class="plaintext"></pre></div></div></div></div><div class="src-link"><a href="https://github.com/nathanmarz/specter/tree/0.12.0/src/clj/com/rpl/specter/protocols.cljx#L19">view source</a></div></div><div class="public anchor" id="var-Navigator"><h3>Navigator</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-select*"><h3>select*</h3><div class="usage"><code>(select* this structure next-fn)</code></div><div class="doc"><pre class="plaintext">An implementation of `select*` must call `next-fn` on each
|
||||
subvalue of `structure`. The result of `select*` is specified
|
||||
as follows:
|
||||
|
||||
1. `NONE` if `next-fn` never called
|
||||
2. `NONE` if all calls to `next-fn` return `NONE`
|
||||
3. Otherwise, any non-`NONE` return value from calling `next-fn`
|
||||
</pre></div></div><div class="public anchor" id="var-transform*"><h3>transform*</h3><div class="usage"><code>(transform* this structure next-fn)</code></div><div class="doc"><pre class="plaintext">An implementation of `transform*` must use `next-fn` to transform
|
||||
any subvalues of `structure` and then merge those transformed values
|
||||
back into `structure`. Everything else in `structure` must be unchanged.</pre></div></div></div></div><div class="src-link"><a href="https://github.com/nathanmarz/specter/tree/0.12.0/src/clj/com/rpl/specter/protocols.cljx#L3">view source</a></div></div></div></body></html>
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
<!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.transients 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.2</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 branch"><a href="com.rpl.specter.protocols.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>protocols</span></div></a></li><li class="depth-4 branch current"><a href="com.rpl.specter.transients.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>transients</span></div></a></li><li class="depth-4"><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.transients.html#var-END.21"><div class="inner"><span>END!</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.transients.html#var-FIRST.21"><div class="inner"><span>FIRST!</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.transients.html#var-keypath.21"><div class="inner"><span>keypath!</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.transients.html#var-LAST.21"><div class="inner"><span>LAST!</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.transients.html#var-submap.21"><div class="inner"><span>submap!</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">com.rpl.specter.transients</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-END.21"><h3>END!</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigates to an empty (persistent) vector at the end of a transient vector.
|
||||
</pre></div><div class="src-link"><a href="https://github.com/nathanmarz/specter/tree/0.11.2/src/clj/com/rpl/specter/transients.cljx#L24">view source</a></div></div><div class="public anchor" id="var-FIRST.21"><h3>FIRST!</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigates to the first element of a transient vector.
|
||||
</pre></div><div class="src-link"><a href="https://github.com/nathanmarz/specter/tree/0.11.2/src/clj/com/rpl/specter/transients.cljx#L45">view source</a></div></div><div class="public anchor" id="var-keypath.21"><h3>keypath!</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigates to the specified key of a transient collection,
|
||||
navigating to nil if it doesn't exist.</pre></div><div class="src-link"><a href="https://github.com/nathanmarz/specter/tree/0.11.2/src/clj/com/rpl/specter/transients.cljx#L14">view source</a></div></div><div class="public anchor" id="var-LAST.21"><h3>LAST!</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigates to the last element of a transient vector.
|
||||
</pre></div><div class="src-link"><a href="https://github.com/nathanmarz/specter/tree/0.11.2/src/clj/com/rpl/specter/transients.cljx#L49">view source</a></div></div><div class="public anchor" id="var-submap.21"><h3>submap!</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigates to the specified persistent submap of a transient map.
|
||||
</pre></div><div class="src-link"><a href="https://github.com/nathanmarz/specter/tree/0.11.2/src/clj/com/rpl/specter/transients.cljx#L76">view source</a></div></div></div></body></html>
|
||||
<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.transients 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.12.0</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 branch"><a href="com.rpl.specter.protocols.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>protocols</span></div></a></li><li class="depth-4 branch current"><a href="com.rpl.specter.transients.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>transients</span></div></a></li><li class="depth-4"><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.transients.html#var-END.21"><div class="inner"><span>END!</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.transients.html#var-FIRST.21"><div class="inner"><span>FIRST!</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.transients.html#var-keypath.21"><div class="inner"><span>keypath!</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.transients.html#var-LAST.21"><div class="inner"><span>LAST!</span></div></a></li><li class="depth-1"><a href="com.rpl.specter.transients.html#var-submap.21"><div class="inner"><span>submap!</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">com.rpl.specter.transients</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-END.21"><h3>END!</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigates to an empty (persistent) vector at the end of a transient vector.
|
||||
</pre></div><div class="src-link"><a href="https://github.com/nathanmarz/specter/tree/0.12.0/src/clj/com/rpl/specter/transients.cljx#L24">view source</a></div></div><div class="public anchor" id="var-FIRST.21"><h3>FIRST!</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigates to the first element of a transient vector.
|
||||
</pre></div><div class="src-link"><a href="https://github.com/nathanmarz/specter/tree/0.12.0/src/clj/com/rpl/specter/transients.cljx#L45">view source</a></div></div><div class="public anchor" id="var-keypath.21"><h3>keypath!</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigates to the specified key of a transient collection,
|
||||
navigating to nil if it doesn't exist.</pre></div><div class="src-link"><a href="https://github.com/nathanmarz/specter/tree/0.12.0/src/clj/com/rpl/specter/transients.cljx#L14">view source</a></div></div><div class="public anchor" id="var-LAST.21"><h3>LAST!</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigates to the last element of a transient vector.
|
||||
</pre></div><div class="src-link"><a href="https://github.com/nathanmarz/specter/tree/0.12.0/src/clj/com/rpl/specter/transients.cljx#L49">view source</a></div></div><div class="public anchor" id="var-submap.21"><h3>submap!</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Navigates to the specified persistent submap of a transient map.
|
||||
</pre></div><div class="src-link"><a href="https://github.com/nathanmarz/specter/tree/0.12.0/src/clj/com/rpl/specter/transients.cljx#L76">view source</a></div></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue