dog-and-duck/docs/codox/index.html

3 lines
17 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>Dog-and-duck 0.1.0-SNAPSHOT</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">Dog-and-duck</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 current"><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="Using_ActivityPub.html"><div class="inner"><span>Using ActivityPub</span></div></a></li><li class="depth-1 "><a href="Validation_Faults.html"><div class="inner"><span>Validation Faults in ActivityPub documents</span></div></a></li><li class="depth-1 "><a href="intro.html"><div class="inner"><span>Introduction</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>clj-activitypub</span></div></div></li><li class="depth-2 branch"><a href="clj-activitypub.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></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>internal</span></div></div></li><li class="depth-3 branch"><a href="clj-activitypub.internal.crypto.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>crypto</span></div></a></li><li class="depth-3 branch"><a href="clj-activitypub.internal.http-util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>http-util</span></div></a></li><li class="depth-3"><a href="clj-activitypub.internal.thread-cache.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>thread-cache</span></div></a></li><li class="depth-2"><a href="clj-activitypub.webfinger.html"><div class="inner"><span class="tree" style="top: -114px;"><span class="top" style="height: 123px;"></span><span class="bottom"></span></span><span>webfinger</span></div></a></li><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree" style="top: -207px;"><span class="top" style="height: 216px;"></span><span class="bottom"></span></span><span>dog-and-duck</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>quack</span></div></div></li><li class="depth-3 branch"><a href="dog-and-duck.quack.fault-messages.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>fault-messages</span></div></a></li><li class="depth-3 branch"><a href="dog-and-duck.quack.picky.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>picky</span></div></a></li><li class="depth-3"><a href="dog-and-duck.quack.quack.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>quack</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -114px;"><span class="top" style="height: 123px;"></span><span class="bottom"></span></span><span>scratch</span></div></div></li><li class="depth-3 branch"><a href="dog-and-duck.scratch.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-3 branch"><a href="dog-and-duck.scratch.parser.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>parser</span></div></a></li><li class="depth-3"><a href="dog-and-duck.scratch.scratch.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>scratch</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -114px;"><span class="top" style="height: 123px;"></span><span class="bottom"></span></span><span>utils</span></div></div></li><li class="depth-3"><a href="dog-and-duck.utils.process.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>process</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Dog-and-duck</span> <span class="project-version">0.1.0-SNAPSHOT</span></span></h1><h5 class="license">Released under the <a href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html">GPL-2.0-or-later</a></h5><div class="doc"><p>A playground for hacking ActivityPub stuff.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[dog-and-duck "0.1.0-SNAPSHOT"]</pre><h2>Topics</h2><ul class="topics"><li><a href="Using_ActivityPub.html">Using ActivityPub</a></li><li><a href="Validation_Faults.html">Validation Faults in ActivityPub documents</a></li><li><a href="intro.html">Introduction</a></li></ul><h2>Namespaces</h2><div class="namespace"><h3><a href="clj-activitypub.core.html">clj-activitypub.core</a></h3><div class="doc"><div class="markdown"><p>copied from <a href="https://github.com/jahfer/clj-activitypub">Jahfers clj-activitypub library</a>. If and when Jahfer issues a release of that library, this directory will be deleted and a dependency on that library will be added to the project.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="clj-activitypub.core.html#var-activity">activity</a> </li><li> <a href="clj-activitypub.core.html#var-actor">actor</a> </li><li> <a href="clj-activitypub.core.html#var-auth-headers">auth-headers</a> </li><li> <a href="clj-activitypub.core.html#var-config">config</a> </li><li> <a href="clj-activitypub.core.html#var-fetch-user">fetch-user</a> </li><li> <a href="clj-activitypub.core.html#var-gen-signature-header">gen-signature-header</a> </li><li> <a href="clj-activitypub.core.html#var-obj">obj</a> </li><li> <a href="clj-activitypub.core.html#var-parse-account">parse-account</a> </li><li> <a href="clj-activitypub.core.html#var-signature-headers">signature-headers</a> </li><li> <a href="clj-activitypub.core.html#var-with-config">with-config</a> </li></ul></div></div><div class="namespace"><h3><a href="clj-activitypub.internal.crypto.html">clj-activitypub.internal.crypto</a></h3><div class="doc"><div class="markdown"><p>copied from <a href="https://github.com/jahfer/clj-activitypub">Jahfers clj-activitypub library</a>. If and when Jahfer issues a release of that library, this directory will be deleted and a dependency on that library will be added to the project.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="clj-activitypub.internal.crypto.html#var-base64-encode">base64-encode</a> </li><li> <a href="clj-activitypub.internal.crypto.html#var-private-key">private-key</a> </li><li> <a href="clj-activitypub.internal.crypto.html#var-sha256-base64">sha256-base64</a> </li><li> <a href="clj-activitypub.internal.crypto.html#var-sign">sign</a> </li></ul></div></div><div class="namespace"><h3><a href="clj-activitypub.internal.http-util.html">clj-activitypub.internal.http-util</a></h3><div class="doc"><div class="markdown"><p>copied from <a href="https://github.com/jahfer/clj-activitypub">Jahfers clj-activitypub library</a>. If and when Jahfer issues a release of that library, this directory will be deleted and a dependency on that library will be added to the project.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="clj-activitypub.internal.http-util.html#var-date">date</a> </li><li> <a href="clj-activitypub.internal.http-util.html#var-digest">digest</a> </li><li> <a href="clj-activitypub.internal.http-util.html#var-encode-url-params">encode-url-params</a> </li></ul></div></div><div class="namespace"><h3><a href="clj-activitypub.internal.thread-cache.html">clj-activitypub.internal.thread-cache</a></h3><div class="doc"><div class="markdown"><p>copied from <a href="https://github.com/jahfer/clj-activitypub">Jahfers clj-activitypub library</a>. If and when Jahfer issues a release of that library, this directory will be deleted and a dependency on that library will be added to the project.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="clj-activitypub.internal.thread-cache.html#var-make">make</a> </li></ul></div></div><div class="namespace"><h3><a href="clj-activitypub.webfinger.html">clj-activitypub.webfinger</a></h3><div class="doc"><div class="markdown"><p>copied from <a href="https://github.com/jahfer/clj-activitypub">Jahfers clj-activitypub library</a>. If and when Jahfer issues a release of that library, this directory will be deleted and a dependency on that library will be added to the project.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="clj-activitypub.webfinger.html#var-fetch-user-id">fetch-user-id</a> </li><li> <a href="clj-activitypub.webfinger.html#var-remote-uri-path">remote-uri-path</a> </li><li> <a href="clj-activitypub.webfinger.html#var-resource-url">resource-url</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.quack.fault-messages.html">dog-and-duck.quack.fault-messages</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.quack.fault-messages.html#var-messages">messages</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.quack.picky.html">dog-and-duck.quack.picky</a></h3><div class="doc"><div class="markdown"><p>Fault-finder for ActivityPub documents. </p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.quack.picky.html#var-*reify-refs*">*reify-refs*</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-*reject-severity*">*reject-severity*</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-accept-required-properties">accept-required-properties</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-activity-faults">activity-faults</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-activity-required-properties">activity-required-properties</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-activity-type-faults">activity-type-faults</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-activitystreams-context-uri">activitystreams-context-uri</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-actor-faults">actor-faults</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-actor-type.3F">actor-type?</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-actor-types">actor-types</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-base-activity-required-properties">base-activity-required-properties</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-coll-object-reference-or-fault">coll-object-reference-or-fault</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-context-key">context-key</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-context.3F">context?</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-filter-severity">filter-severity</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-has-activity-type.3F">has-activity-type?</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-has-actor-type.3F">has-actor-type?</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-has-context.3F">has-context?</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-has-type-or-fault">has-type-or-fault</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-has-type.3F">has-type?</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-intransitive-activity-required-properties">intransitive-activity-required-properties</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-link-faults">link-faults</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-make-fault-object">make-fault-object</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-nil-if-empty">nil-if-empty</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-object-faults">object-faults</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-object-reference-or-faults">object-reference-or-faults</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-persistent-object-faults">persistent-object-faults</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-severity">severity</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-severity-filters">severity-filters</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-string-or-fault">string-or-fault</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-truthy.3F">truthy?</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-uri-or-fault">uri-or-fault</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-validation-fault-context-uri">validation-fault-context-uri</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-verb-type.3F">verb-type?</a> </li><li> <a href="dog-and-duck.quack.picky.html#var-verb-types">verb-types</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.quack.quack.html">dog-and-duck.quack.quack</a></h3><div class="doc"><div class="markdown"><p>Validator for ActivityPub objects: if it walks like a duck, and it quacks like a duck…</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.quack.quack.html#var-activity.3F">activity?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-actor-or-uri.3F">actor-or-uri?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-actor.3F">actor?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-collection-page.3F">collection-page?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-collection.3F">collection?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-link-or-uri.3F">link-or-uri?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-link.3F">link?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-object.3F">object?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-ordered-collection-page.3F">ordered-collection-page?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-ordered-collection.3F">ordered-collection?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-persistent-object.3F">persistent-object?</a> </li><li> <a href="dog-and-duck.quack.quack.html#var-unordered-collection.3F">unordered-collection?</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.scratch.core.html">dog-and-duck.scratch.core</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.scratch.core.html#var-foo">foo</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.scratch.parser.html">dog-and-duck.scratch.parser</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.scratch.parser.html#var-clean">clean</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.scratch.scratch.html">dog-and-duck.scratch.scratch</a></h3><div class="doc"><div class="markdown"><p>Scratchpad where I try to understand how to do this stuff.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.scratch.scratch.html#var-account">account</a> </li><li> <a href="dog-and-duck.scratch.scratch.html#var-account-handle">account-handle</a> </li><li> <a href="dog-and-duck.scratch.scratch.html#var-handle">handle</a> </li></ul></div></div><div class="namespace"><h3><a href="dog-and-duck.utils.process.html">dog-and-duck.utils.process</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="dog-and-duck.utils.process.html#var-get-hostname">get-hostname</a> </li><li> <a href="dog-and-duck.utils.process.html#var-get-pid">get-pid</a> </li></ul></div></div></div></body></html>