13 lines
9.3 KiB
HTML
13 lines
9.3 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
|
"">
|
|
<html><head><meta charset="UTF-8" /><title>beowulf.gendoc documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><link rel="icon" type="image/x-icon" href="../img/beowulf_logo_favicon.png" /></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">Beowulf</span> <span class="project-version">0.3.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">Topics</span></h3><ul><li class="depth-1 "><a href="further_reading.html"><div class="inner"><span>Further Reading</span></div></a></li><li class="depth-1 "><a href="intro.html"><div class="inner"><span>beowulf</span></div></a></li><li class="depth-1 "><a href="mexpr.html"><div class="inner"><span>Interpreting M-Expressions</span></div></a></li><li class="depth-1 "><a href="values.html"><div class="inner"><span>The properties of the system, and their values</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>beowulf</span></div></div></li><li class="depth-2 branch"><a href="beowulf.bootstrap.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>bootstrap</span></div></a></li><li class="depth-2 branch"><a href="beowulf.cons-cell.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cons-cell</span></div></a></li><li class="depth-2 branch"><a href="beowulf.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 branch current"><a href="beowulf.gendoc.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>gendoc</span></div></a></li><li class="depth-2 branch"><a href="beowulf.host.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>host</span></div></a></li><li class="depth-2 branch"><a href="beowulf.interop.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>interop</span></div></a></li><li class="depth-2 branch"><a href="beowulf.io.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>io</span></div></a></li><li class="depth-2 branch"><a href="beowulf.manual.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>manual</span></div></a></li><li class="depth-2 branch"><a href="beowulf.oblist.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>oblist</span></div></a></li><li class="depth-2 branch"><a href="beowulf.read.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>read</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>reader</span></div></div></li><li class="depth-3 branch"><a href="beowulf.reader.char-reader.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>char-reader</span></div></a></li><li class="depth-3 branch"><a href="beowulf.reader.generate.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>generate</span></div></a></li><li class="depth-3 branch"><a href="beowulf.reader.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-3 branch"><a href="beowulf.reader.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="beowulf.reader.simplify.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>simplify</span></div></a></li><li class="depth-2"><a href="beowulf.scratch.html"><div class="inner"><span class="tree" style="top: -176px;"><span class="top" style="height: 185px;"></span><span class="bottom"></span></span><span>scratch</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="beowulf.gendoc.html#var-find-documentation"><div class="inner"><span>find-documentation</span></div></a></li><li class="depth-1"><a href="beowulf.gendoc.html#var-gen-doc-table"><div class="inner"><span>gen-doc-table</span></div></a></li><li class="depth-1"><a href="beowulf.gendoc.html#var-gen-index"><div class="inner"><span>gen-index</span></div></a></li><li class="depth-1"><a href="beowulf.gendoc.html#var-host-functions"><div class="inner"><span>host-functions</span></div></a></li><li class="depth-1"><a href="beowulf.gendoc.html#var-infer-implementation"><div class="inner"><span>infer-implementation</span></div></a></li><li class="depth-1"><a href="beowulf.gendoc.html#var-infer-signature"><div class="inner"><span>infer-signature</span></div></a></li><li class="depth-1"><a href="beowulf.gendoc.html#var-infer-type"><div class="inner"><span>infer-type</span></div></a></li><li class="depth-1"><a href="beowulf.gendoc.html#var-open-doc"><div class="inner"><span>open-doc</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">beowulf.gendoc</h1><div class="doc"><div class="markdown"><p>Generate table of documentation of Lisp symbols and functions.</p>
|
|
<p>NOTE: this is <em>very</em> hacky. You almost certainly do not want to use this!</p>
|
|
</div></div><div class="public anchor" id="var-find-documentation"><h3>find-documentation</h3><div class="usage"><code>(find-documentation entry)</code></div><div class="doc"><div class="markdown"><p>Find appropriate documentation for this <code>entry</code> from the oblist.</p>
|
|
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/gendoc.clj#L122">view source</a></div></div><div class="public anchor" id="var-gen-doc-table"><h3>gen-doc-table</h3><div class="usage"><code>(gen-doc-table)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
|
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/gendoc.clj#L133">view source</a></div></div><div class="public anchor" id="var-gen-index"><h3>gen-index</h3><div class="usage"><code>(gen-index)</code><code>(gen-index url destination)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
|
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/gendoc.clj#L156">view source</a></div></div><div class="public anchor" id="var-host-functions"><h3>host-functions</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>Functions which we can infer are written in Clojure. We need to collect these at run-time, not compile time, hence memoised function, not variable.</p>
|
|
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/gendoc.clj#L33">view source</a></div></div><div class="public anchor" id="var-infer-implementation"><h3>infer-implementation</h3><div class="usage"><code>(infer-implementation entry)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
|
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/gendoc.clj#L114">view source</a></div></div><div class="public anchor" id="var-infer-signature"><h3>infer-signature</h3><div class="usage"><code>(infer-signature entry)</code></div><div class="doc"><div class="markdown"><p>Infer the signature of the function value of this oblist <code>entry</code>, if any.</p>
|
|
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/gendoc.clj#L104">view source</a></div></div><div class="public anchor" id="var-infer-type"><h3>infer-type</h3><div class="usage"><code>(infer-type entry)</code></div><div class="doc"><div class="markdown"><p>Try to work out what this <code>entry</code> from the oblist actually represents.</p>
|
|
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/gendoc.clj#L67">view source</a></div></div><div class="public anchor" id="var-open-doc"><h3>open-doc</h3><div class="usage"><code>(open-doc symbol)</code></div><div class="doc"><div class="markdown"><p>Open the documentation page for this <code>symbol</code>, if known, in the default web browser.</p>
|
|
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/gendoc.clj#L169">view source</a></div></div></div></body></html> |