16 lines
7.1 KiB
HTML
16 lines
7.1 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
||
"">
|
||
<html><head><meta charset="UTF-8" /><title>walkmap.tag documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></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">Walkmap</span> <span class="project-version">0.1.0-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">Topics</span></h3><ul><li class="depth-1 "><a href="dali-performance.html"><div class="inner"><span>Dali performance</span></div></a></li><li class="depth-1 "><a href="intro.html"><div class="inner"><span>Introduction to walkmap</span></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>walkmap</span></div></div></li><li class="depth-2 branch"><a href="walkmap.edge.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>edge</span></div></a></li><li class="depth-2 branch"><a href="walkmap.id.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>id</span></div></a></li><li class="depth-2 branch"><a href="walkmap.ocean.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ocean</span></div></a></li><li class="depth-2 branch"><a href="walkmap.path.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>path</span></div></a></li><li class="depth-2 branch"><a href="walkmap.polygon.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>polygon</span></div></a></li><li class="depth-2 branch"><a href="walkmap.read-svg.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>read-svg</span></div></a></li><li class="depth-2 branch"><a href="walkmap.routing.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>routing</span></div></a></li><li class="depth-2 branch"><a href="walkmap.stl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>stl</span></div></a></li><li class="depth-2 branch"><a href="walkmap.superstructure.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>superstructure</span></div></a></li><li class="depth-2 branch"><a href="walkmap.svg.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>svg</span></div></a></li><li class="depth-2 branch current"><a href="walkmap.tag.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tag</span></div></a></li><li class="depth-2 branch"><a href="walkmap.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-2"><a href="walkmap.vertex.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>vertex</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="walkmap.tag.html#var-tag"><div class="inner"><span>tag</span></div></a></li><li class="depth-1"><a href="walkmap.tag.html#var-tagged.3F"><div class="inner"><span>tagged?</span></div></a></li><li class="depth-1"><a href="walkmap.tag.html#var-tags"><div class="inner"><span>tags</span></div></a></li><li class="depth-1"><a href="walkmap.tag.html#var-untag"><div class="inner"><span>untag</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">walkmap.tag</h1><div class="doc"><div class="markdown"><p>Code for tagging, untagging, and finding tags on objects. Note the use of the namespaced keyword, <code>:walkmap.tag/tags</code>, denoted in this file <code>::tags</code>. This is in an attempt to avoid name clashes with other uses of this key.</p></div></div><div class="public anchor" id="var-tag"><h3>tag</h3><div class="usage"><code>(tag object & tags)</code></div><div class="doc"><div class="markdown"><p>Return an object like this <code>object</code> but with these <code>tags</code> added to its tags, if they are not already present. It is an error (and an exception will be thrown) if</p>
|
||
<ol>
|
||
<li><code>object</code> is not a map;</li>
|
||
<li>any of <code>tags</code> is not a keyword or sequence of keywords.</li>
|
||
</ol>
|
||
<p>It’s legal to include sequences of keywords in <code>tags</code>, so that users can do useful things like <code>(tag obj (map keyword some-strings))</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/tag.clj#L28">view source</a></div></div><div class="public anchor" id="var-tagged.3F"><h3>tagged?</h3><div class="usage"><code>(tagged? object & tags)</code></div><div class="doc"><div class="markdown"><p>True if this <code>object</code> is tagged with each of these <code>tags</code>. It is an error (and an exception will be thrown) if</p>
|
||
<ol>
|
||
<li><code>object</code> is not a map;</li>
|
||
<li>any of <code>tags</code> is not a keyword.</li>
|
||
</ol></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/tag.clj#L9">view source</a></div></div><div class="public anchor" id="var-tags"><h3>tags</h3><h4 class="type">macro</h4><div class="usage"><code>(tags object)</code></div><div class="doc"><div class="markdown"><p>Return the tags of this object, if any.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/tag.clj#L49">view source</a></div></div><div class="public anchor" id="var-untag"><h3>untag</h3><div class="usage"><code>(untag object & tags)</code></div><div class="doc"><div class="markdown"><p>Return an object like this <code>object</code> but with these <code>tags</code> removed from its tags, if present. It is an error (and an exception will be thrown) if</p>
|
||
<ol>
|
||
<li><code>object</code> is not a map;</li>
|
||
<li>any of <code>tags</code> is not a keyword or sequence of keywords.</li>
|
||
</ol></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/tag.clj#L54">view source</a></div></div></div></body></html> |