sleeladoc.html
api/sleela/3.1/version-007/package/sleeladoc.html · 351 line(s) · html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Package sleeladoc — SleelaDoc API</title>
<link rel="stylesheet" href="../style.css">
</head>
<body>
<header class="top">
<div class="brand"><a href="../index.html">SleelaDoc API</a></div>
<div class="tag">HTML documentation for the SLeeLa standard library (/lib)</div>
</header>
<div class="wrap">
<nav class="side">
<a href="../index.html"><strong>Home</strong></a>
<a href="../packages.html"><strong>All packages</strong></a>
<a href="../glossary.html"><strong>Glossary</strong></a>
<a href="../authorship.html"><strong>Authorship</strong></a>
<h2>Packages</h2><ul>
<li><a href="../package/advantage.html">advantage</a></li>
<li><a href="../package/alphabet.html">alphabet</a></li>
<li><a href="../package/antivirus.html">antivirus</a></li>
<li><a href="../package/api.html">api</a></li>
<li><a href="../package/array.html">array</a></li>
<li><a href="../package/audio.html">audio</a></li>
<li><a href="../package/autocad.html">autocad</a></li>
<li><a href="../package/ballum.html">ballum</a></li>
<li><a href="../package/bash.html">bash</a></li>
<li><a href="../package/boolean.html">boolean</a></li>
<li><a href="../package/cdma.html">cdma</a></li>
<li><a href="../package/char.html">char</a></li>
<li><a href="../package/character.html">character</a></li>
<li><a href="../package/character-recognition.html">character-recognition</a></li>
<li><a href="../package/churn.html">churn</a></li>
<li><a href="../package/citizen.html">citizen</a></li>
<li><a href="../package/codecs.html">codecs</a></li>
<li><a href="../package/collections.html">collections</a></li>
<li><a href="../package/common-rails.html">common-rails</a></li>
<li><a href="../package/compiler.html">compiler</a></li>
<li><a href="../package/compression.html">compression</a></li>
<li><a href="../package/config.html">config</a></li>
<li><a href="../package/connector.html">connector</a></li>
<li><a href="../package/coorenagraph.html">coorenagraph</a></li>
<li><a href="../package/core.html">core</a></li>
<li><a href="../package/cpu.html">cpu</a></li>
<li><a href="../package/crypto.html">crypto</a></li>
<li><a href="../package/data.html">data</a></li>
<li><a href="../package/data-structures.html">data-structures</a></li>
<li><a href="../package/database.html">database</a></li>
<li><a href="../package/debugger.html">debugger</a></li>
<li><a href="../package/decompiler.html">decompiler</a></li>
<li><a href="../package/deliberation.html">deliberation</a></li>
<li><a href="../package/drivers.html">drivers</a></li>
<li><a href="../package/examples.html">examples</a></li>
<li><a href="../package/filesystem.html">filesystem</a></li>
<li><a href="../package/gameplay.html">gameplay</a></li>
<li><a href="../package/governance.html">governance</a></li>
<li><a href="../package/gui.html">gui</a></li>
<li><a href="../package/guidoc.html">guidoc</a></li>
<li><a href="../package/hotlink.html">hotlink</a></li>
<li><a href="../package/html.html">html</a></li>
<li><a href="../package/http.html">http</a></li>
<li><a href="../package/http-1.0.html">http-1.0</a></li>
<li><a href="../package/http-2.0.html">http-2.0</a></li>
<li><a href="../package/http-3.0.html">http-3.0</a></li>
<li><a href="../package/http-4.0.html">http-4.0</a></li>
<li><a href="../package/http-5.0.html">http-5.0</a></li>
<li><a href="../package/http-6.0.html">http-6.0</a></li>
<li><a href="../package/http-7.0.html">http-7.0</a></li>
<li><a href="../package/http-8.0.html">http-8.0</a></li>
<li><a href="../package/http-9.0.html">http-9.0</a></li>
<li><a href="../package/http-servers.html">http-servers</a></li>
<li><a href="../package/ide.html">ide</a></li>
<li><a href="../package/ide-workbench.html">ide-workbench</a></li>
<li><a href="../package/idea.html">idea</a></li>
<li><a href="../package/inference-model.html">inference-model</a></li>
<li><a href="../package/inputs.html">inputs</a></li>
<li><a href="../package/international-criminal-court.html">international-criminal-court</a></li>
<li><a href="../package/io.html">io</a></li>
<li><a href="../package/java.html">java</a></li>
<li><a href="../package/java28.html">java28</a></li>
<li><a href="../package/journey.html">journey</a></li>
<li><a href="../package/languages.html">languages</a></li>
<li><a href="../package/large-language-models.html">large-language-models</a></li>
<li><a href="../package/ledger.html">ledger</a></li>
<li><a href="../package/linux-editors.html">linux-editors</a></li>
<li><a href="../package/manifesto.html">manifesto</a></li>
<li><a href="../package/math.html">math</a></li>
<li><a href="../package/memory.html">memory</a></li>
<li><a href="../package/modules.html">modules</a></li>
<li><a href="../package/moral-capacitor.html">moral-capacitor</a></li>
<li><a href="../package/munction.html">munction</a></li>
<li><a href="../package/native.html">native</a></li>
<li><a href="../package/net.html">net</a></li>
<li><a href="../package/neural-nets.html">neural-nets</a></li>
<li><a href="../package/nordshrift.html">nordshrift</a></li>
<li><a href="../package/observer.html">observer</a></li>
<li><a href="../package/opcodes.html">opcodes</a></li>
<li><a href="../package/operating-system.html">operating-system</a></li>
<li><a href="../package/os-level-support.html">os-level-support</a></li>
<li><a href="../package/philosophers.html">philosophers</a></li>
<li><a href="../package/philosophy.html">philosophy</a></li>
<li><a href="../package/politico.html">politico</a></li>
<li><a href="../package/process.html">process</a></li>
<li><a href="../package/psychiatry.html">psychiatry</a></li>
<li><a href="../package/public.html">public</a></li>
<li><a href="../package/reflection.html">reflection</a></li>
<li><a href="../package/regex.html">regex</a></li>
<li><a href="../package/registry.html">registry</a></li>
<li><a href="../package/rmi.html">rmi</a></li>
<li><a href="../package/rrs.html">rrs</a></li>
<li><a href="../package/runtime.html">runtime</a></li>
<li><a href="../package/security.html">security</a></li>
<li><a href="../package/server-edition.html">server-edition</a></li>
<li><a href="../package/signal-processing.html">signal-processing</a></li>
<li><a href="../package/sldocument.html">sldocument</a></li>
<li><a href="../package/sleela.html">sleela</a></li>
<li><a href="../package/sleela-sql.html">sleela-sql</a></li>
<li><a href="../package/sleela-terminal.html">sleela-terminal</a></li>
<li><a href="../package/sleeladoc.html">sleeladoc</a></li>
<li><a href="../package/slrtp.html">slrtp</a></li>
<li><a href="../package/social-model.html">social-model</a></li>
<li><a href="../package/softlisten.html">softlisten</a></li>
<li><a href="../package/sommeliers.html">sommeliers</a></li>
<li><a href="../package/spatial.html">spatial</a></li>
<li><a href="../package/sst.html">sst</a></li>
<li><a href="../package/synchro.html">synchro</a></li>
<li><a href="../package/systems.html">systems</a></li>
<li><a href="../package/telephony-skya.html">telephony-skya</a></li>
<li><a href="../package/terminal.html">terminal</a></li>
<li><a href="../package/terminal_pixel.html">terminal_pixel</a></li>
<li><a href="../package/text.html">text</a></li>
<li><a href="../package/ui.html">ui</a></li>
<li><a href="../package/us-infrastructure.html">us-infrastructure</a></li>
<li><a href="../package/user-interface.html">user-interface</a></li>
<li><a href="../package/video.html">video</a></li>
<li><a href="../package/vm.html">vm</a></li>
<li><a href="../package/web-server-technology.html">web-server-technology</a></li>
<li><a href="../package/website.html">website</a></li>
<li><a href="../package/wifi.html">wifi</a></li>
<li><a href="../package/xlt.html">xlt</a></li>
<li><a href="../package/xml.html">xml</a></li>
</ul>
</nav>
<main>
<div class="crumbs"><a href="../index.html">Home</a> › <a href="../packages.html">Packages</a> › sleeladoc</div>
<h1>Package <code>sleeladoc</code></h1>
<div class="lead">This package contains <strong>9</strong> source unit(s) defining <strong>9</strong> class(es) / struct(s). Each unit below lists its fields (the values it stores) and methods (the actions it performs), with a plain explanation of each.</div>
<input class="search" placeholder="Filter on this page (Ctrl+F also works)…" oninput="flt(this.value)">
<h2 class="section" data-u="sldoccomment">SLDocComment <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/sleeladoc/SLDocComment.sleela)</span></h2>
<div data-u="sldoccomment sldoccomment">
<h3 id="SLDocComment">SLDocComment <span class="pill">class</span></h3>
<p class="desc">Defines SLDocComment -- one parsed SleelaDoc block: its free-prose summary plus an ordered list of @tags.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>summary</code></td><td><span class="sig">String summary = ""</span></td><td class="desc">The free-prose summary (text before the first @tag); "" when none.</td></tr>
<tr><td><code>tags</code></td><td><span class="sig">SLDocTag[] tags = new SLDocTag[0]</span></td><td class="desc">Ordered @tags; a growable VM-managed object array.</td></tr>
<tr><td><code>tagN</code></td><td><span class="sig">int tagN = 0</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setSummary</code></td><td><span class="sig">void setSummary(String s)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getSummary</code></td><td><span class="sig">String getSummary()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addTag</code></td><td><span class="sig">void addTag(SLDocTag t)</span></td><td class="desc">Append a parsed tag, preserving source order.</td></tr>
<tr><td><code>addTagOf</code></td><td><span class="sig">void addTagOf(String n, String v)</span></td><td class="desc">Convenience: build and append a tag from name + value.</td></tr>
<tr><td><code>tagCount</code></td><td><span class="sig">int tagCount()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tagAt</code></td><td><span class="sig">SLDocTag tagAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>indexOfTag</code></td><td><span class="sig">int indexOfTag(String n)</span></td><td class="desc">Index of the first tag with name `n`, or -1.</td></tr>
<tr><td><code>hasTag</code></td><td><span class="sig">boolean hasTag(String n)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tagValue</code></td><td><span class="sig">String tagValue(String n)</span></td><td class="desc">The value of the first tag named `n`, or "" when absent.</td></tr>
<tr><td><code>empty</code></td><td><span class="sig">boolean empty()</span></td><td class="desc">True when the comment carries nothing (no summary and no tags).</td></tr>
</table>
</div>
<h2 class="section" data-u="sldocmember">SLDocMember <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/sleeladoc/SLDocMember.sleela)</span></h2>
<div data-u="sldocmember sldocmember">
<h3 id="SLDocMember">SLDocMember <span class="pill">class</span></h3>
<p class="desc">Defines SLDocMember -- a documented declaration (class, field, or method) with its signature line and the SleelaDoc comment attached to it.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>CLASS</code></td><td><span class="sig">static final int CLASS = 0</span></td><td class="desc">---- the member kinds ----</td></tr>
<tr><td><code>FIELD</code></td><td><span class="sig">static final int FIELD = 1</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>METHOD</code></td><td><span class="sig">static final int METHOD = 2</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>kind</code></td><td><span class="sig">int kind</span></td><td class="desc">nodeType of this member (one of the kind codes above).</td></tr>
<tr><td><code>memberName</code></td><td><span class="sig">String memberName</span></td><td class="desc">The member name (class name, field name, or method name).</td></tr>
<tr><td><code>signature</code></td><td><span class="sig">String signature</span></td><td class="desc">The raw signature line as written in source.</td></tr>
<tr><td><code>doc</code></td><td><span class="sig">SLDocComment doc</span></td><td class="desc">The attached SleelaDoc comment, or null when undocumented.</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>set</code></td><td><span class="sig">void set(int k, String n, String sig)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>attach</code></td><td><span class="sig">void attach(SLDocComment c)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getKind</code></td><td><span class="sig">int getKind()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getName</code></td><td><span class="sig">String getName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getSignature</code></td><td><span class="sig">String getSignature()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getDoc</code></td><td><span class="sig">SLDocComment getDoc()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>documented</code></td><td><span class="sig">boolean documented()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>kindName</code></td><td><span class="sig">String kindName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="sldocmodel">SLDocModel <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/sleeladoc/SLDocModel.sleela)</span></h2>
<div data-u="sldocmodel sldocmodel">
<h3 id="SLDocModel">SLDocModel <span class="pill">class</span></h3>
<p class="desc">Defines SLDocModel -- the parsed SleelaDoc model of a whole unit: the unit name and its documented members in declaration order.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>unitName</code></td><td><span class="sig">String unitName = ""</span></td><td class="desc">The unit name (the source base name a caller supplies).</td></tr>
<tr><td><code>members</code></td><td><span class="sig">SLDocMember[] members = new SLDocMember[0]</span></td><td class="desc">Documented members in declaration order; growable VM-managed object array.</td></tr>
<tr><td><code>memberN</code></td><td><span class="sig">int memberN = 0</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUnitName</code></td><td><span class="sig">void setUnitName(String n)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getUnitName</code></td><td><span class="sig">String getUnitName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addMember</code></td><td><span class="sig">void addMember(SLDocMember m)</span></td><td class="desc">Append a member, preserving declaration order.</td></tr>
<tr><td><code>memberCount</code></td><td><span class="sig">int memberCount()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>memberAt</code></td><td><span class="sig">SLDocMember memberAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>countKind</code></td><td><span class="sig">int countKind(int kind)</span></td><td class="desc">Count members of a given kind (0 class, 1 field, 2 method).</td></tr>
<tr><td><code>documentedCount</code></td><td><span class="sig">int documentedCount()</span></td><td class="desc">Count members carrying a non-empty doc comment.</td></tr>
</table>
</div>
<h2 class="section" data-u="sldocrenderer">SLDocRenderer <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/sleeladoc/SLDocRenderer.sleela)</span></h2>
<div data-u="sldocrenderer sldocrenderer">
<h3 id="SLDocRenderer">SLDocRenderer <span class="pill">class</span></h3>
<p class="desc">Defines SLDocRenderer -- renders a parsed SLDocModel as a Markdown or minimal HTML API page (the way javadoc renders an HTML page for Java).</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>toMarkdown</code></td><td><span class="sig">String toMarkdown(SLDocModel model)</span></td><td class="desc">Render the whole model as a Markdown API page.</td></tr>
<tr><td><code>mdMember</code></td><td><span class="sig">String mdMember(SLDocMember m, String nl)</span></td><td class="desc">One member as a Markdown section.</td></tr>
<tr><td><code>toHtml</code></td><td><span class="sig">String toHtml(SLDocModel model)</span></td><td class="desc">Render the whole model as a minimal self-contained HTML fragment.</td></tr>
<tr><td><code>htmlMember</code></td><td><span class="sig">String htmlMember(SLDocMember m, String nl)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>esc</code></td><td><span class="sig">String esc(String s)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="sldocscanner">SLDocScanner <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/sleeladoc/SLDocScanner.sleela)</span></h2>
<div data-u="sldocscanner sldocscanner">
<h3 id="SLDocScanner">SLDocScanner <span class="pill">class</span></h3>
<p class="desc">Defines SLDocScanner -- the token-stream reader that lifts SleelaDoc @doc / @page blocks and @tags out of a .sleela unit and attaches each doc comment to the declaration that follows it, building an SLDocModel.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>model</code></td><td><span class="sig">SLDocModel model</span></td><td class="desc">---- scanner state ----</td></tr>
<tr><td><code>current</code></td><td><span class="sig">SLDocComment current</span></td><td class="desc">the doc comment being accumulated, or null when outside a block</td></tr>
<tr><td><code>inBlock</code></td><td><span class="sig">boolean inBlock = false</span></td><td class="desc">true while inside a doc block (between its opener and closer)</td></tr>
<tr><td><code>pending</code></td><td><span class="sig">SLDocComment pending</span></td><td class="desc">the last completed doc comment, pending attachment to a declaration</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>begin</code></td><td><span class="sig">void begin(String unitName)</span></td><td class="desc">Begin a scan of a unit named `unitName`.</td></tr>
<tr><td><code>getModel</code></td><td><span class="sig">SLDocModel getModel()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>joinTokens</code></td><td><span class="sig">String joinTokens(String[] toks, int from, int to)</span></td><td class="desc">Join tokens [from, to) with single spaces into one value string.</td></tr>
<tr><td><code>isScalarType</code></td><td><span class="sig">boolean isScalarType(String word)</span></td><td class="desc">True when `word` names a scalar/known declaration type head (so a line that starts with it is a field or method, not prose). Covers the surface type vocabulary plus the SL* / upper-initial class-type convention is handled by the caller marking declaration lines; here we accept the common scalars and treat any other token as a possible class-typed return/field via isTypeish.</td></tr>
<tr><td><code>isTypeHead</code></td><td><span class="sig">boolean isTypeHead(String word, boolean upperInitial)</span></td><td class="desc">A token looks like a type head if it is a known scalar or begins uppercase (the SLeeLa class-name convention). The caller passes an explicit flag for ambiguous cases; this is the default heuristic.</td></tr>
<tr><td><code>feed</code></td><td><span class="sig">void feed(String[] toks, boolean upperInitial)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>openBlock</code></td><td><span class="sig">void openBlock()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>closeBlock</code></td><td><span class="sig">void closeBlock()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>absorbBlockLine</code></td><td><span class="sig">void absorbBlockLine(String[] toks)</span></td><td class="desc">A line inside a block: the closer is handled in feed(), so absorb all here.</td></tr>
<tr><td><code>absorbTokens</code></td><td><span class="sig">void absorbTokens(String[] toks, int from, int to)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>startsWithAt</code></td><td><span class="sig">boolean startsWithAt(String t)</span></td><td class="desc">True when token `t` is a tag marker "@name". Compares the first glyph via a single-cell token test the caller cannot give us, so we test known markers: a token equals "@" + a known tag name. This keeps it whole-string and real.</td></tr>
<tr><td><code>tagNameOf</code></td><td><span class="sig">String tagNameOf(String t)</span></td><td class="desc">The tag name for a known "@name" marker (the marker without the "@").</td></tr>
<tr><td><code>classifyDeclaration</code></td><td><span class="sig">void classifyDeclaration(String[] toks, boolean upperInitial)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hasParen</code></td><td><span class="sig">boolean hasParen(String[] toks)</span></td><td class="desc">True when the tokens include a "(" marker (the caller tokenizes "name(" as two tokens "name" "(" or passes "(" standalone).</td></tr>
<tr><td><code>nameToken</code></td><td><span class="sig">String nameToken(String[] toks)</span></td><td class="desc">The declared name: the token right after the type head (toks[1]).</td></tr>
<tr><td><code>addMemberRecord</code></td><td><span class="sig">void addMemberRecord(int kind, String nm, String sig)</span></td><td class="desc">Record a member of `kind` named `nm` with signature `sig`, attaching the pending doc comment (then clearing it).</td></tr>
</table>
</div>
<h2 class="section" data-u="sldoctag">SLDocTag <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/sleeladoc/SLDocTag.sleela)</span></h2>
<div data-u="sldoctag sldoctag">
<h3 id="SLDocTag">SLDocTag <span class="pill">class</span></h3>
<p class="desc">Defines SLDocTag -- one parsed SleelaDoc tag: a name (without the leading @) and its value text.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>tagName</code></td><td><span class="sig">String tagName</span></td><td class="desc">The tag name without the leading "@" (e.g. "intent").</td></tr>
<tr><td><code>tagValue</code></td><td><span class="sig">String tagValue</span></td><td class="desc">The trimmed value text after the tag name.</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>set</code></td><td><span class="sig">void set(String n, String v)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getTagName</code></td><td><span class="sig">String getTagName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>getTagValue</code></td><td><span class="sig">String getTagValue()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>is</code></td><td><span class="sig">boolean is(String n)</span></td><td class="desc">True when this is the given tag name (case-sensitive; tags are lowercase).</td></tr>
</table>
</div>
<h2 class="section" data-u="sleeladoc-demo">sleeladoc-demo <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/sleeladoc/sleeladoc-demo.sleela)</span></h2>
<div data-u="sleeladoc-demo sleeladocdemo">
<h3 id="SleeladocDemo">SleeladocDemo <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>t1</code></td><td><span class="sig">String[] t1(String a)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>t2</code></td><td><span class="sig">String[] t2(String a, String b)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>t3</code></td><td><span class="sig">String[] t3(String a, String b, String c)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>t4</code></td><td><span class="sig">String[] t4(String a, String b, String c, String d)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>t6</code></td><td><span class="sig">String[] t6(String a, String b, String c, String d, String e, String f)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>main</code></td><td><span class="sig">void main()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="slpackage">SLPackage <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/sleeladoc/SLPackage.sleela)</span></h2>
<div data-u="slpackage slpackage">
<h3 id="SLPackage">SLPackage <span class="pill">class</span></h3>
<p class="desc">Defines the SLeeLa standard-library package for sleeladoc -- the SleelaDoc extractor family (the Javadoc-tool analogue for SLeeLa). Exposes the package to the SLeeLa compiler, Loader, and Nordshrift.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>packageName</code></td><td><span class="sig">String packageName</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>configure</code></td><td><span class="sig">void configure(String name)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>name</code></td><td><span class="sig">String name()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>available</code></td><td><span class="sig">boolean available()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="slsleeladoc">SLSleelaDoc <span class="pill syntax">#sleela 3.0</span> <span class="muted" style="font-size:13px">(lib/sleeladoc/SLSleelaDoc.sleela)</span></h2>
<div data-u="slsleeladoc slsleeladoc">
<h3 id="SLSleelaDoc">SLSleelaDoc <span class="pill">class</span></h3>
<p class="desc">Defines SLSleelaDoc -- the one-object facade a caller drives to extract SleelaDoc from a unit and render it: begin, feed tokenized lines, then render Markdown or HTML. The Javadoc-tool analogue entry point.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>scanner</code></td><td><span class="sig">SLDocScanner scanner</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>renderer</code></td><td><span class="sig">SLDocRenderer renderer</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>begin</code></td><td><span class="sig">void begin(String unitName)</span></td><td class="desc">Begin extracting a unit named `unitName`.</td></tr>
<tr><td><code>feed</code></td><td><span class="sig">void feed(String[] toks, boolean upperInitial)</span></td><td class="desc">Feed one tokenized source line; `upperInitial` true when its first token begins with an uppercase letter (computed by the caller at the char-cell boundary). Order of feeds is declaration order.</td></tr>
<tr><td><code>model</code></td><td><span class="sig">SLDocModel model()</span></td><td class="desc">The parsed model (members in declaration order).</td></tr>
<tr><td><code>toMarkdown</code></td><td><span class="sig">String toMarkdown()</span></td><td class="desc">Render the accumulated model as a Markdown API page.</td></tr>
<tr><td><code>toHtml</code></td><td><span class="sig">String toHtml()</span></td><td class="desc">Render the accumulated model as a minimal HTML fragment.</td></tr>
<tr><td><code>memberCount</code></td><td><span class="sig">int memberCount()</span></td><td class="desc">---- quick facts ----</td></tr>
<tr><td><code>documentedCount</code></td><td><span class="sig">int documentedCount()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<script>function flt(q){q=q.toLowerCase();document.querySelectorAll('[data-u]').forEach(function(el){el.style.display = el.getAttribute('data-u').indexOf(q)>=0||q==''?'':'none';});}</script>
<footer>
Generated by <code>tools/generate-sleeladoc-api.py</code> from the live
<code>/lib</code> tree on 2026-11-14 07:49 UTC.
SleelaDoc — the SLeeLa documentation brand. SLeeLa — MEARVK LLC · Max Rupplin · UNCW, NCSU, Harvard · 2026 · George Soros 2507-2608.
</footer>
</main>
</div>
</body>
</html>