Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

Commit

Permalink
docs: api docs build for 2414210
Browse files Browse the repository at this point in the history
  • Loading branch information
NM-EEA-Y committed Sep 3, 2023
1 parent 2528689 commit 58d4b32
Show file tree
Hide file tree
Showing 46 changed files with 546 additions and 534 deletions.
24 changes: 12 additions & 12 deletions assets/highlight.css
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
:root {
--light-hl-0: #000000;
--dark-hl-0: #D4D4D4;
--light-hl-1: #A31515;
--dark-hl-1: #CE9178;
--light-hl-2: #008000;
--dark-hl-2: #6A9955;
--light-hl-3: #0000FF;
--dark-hl-3: #569CD6;
--light-hl-4: #0070C1;
--dark-hl-4: #4FC1FF;
--light-hl-5: #795E26;
--dark-hl-5: #DCDCAA;
--light-hl-0: #795E26;
--dark-hl-0: #DCDCAA;
--light-hl-1: #000000;
--dark-hl-1: #D4D4D4;
--light-hl-2: #A31515;
--dark-hl-2: #CE9178;
--light-hl-3: #008000;
--dark-hl-3: #6A9955;
--light-hl-4: #0000FF;
--dark-hl-4: #569CD6;
--light-hl-5: #0070C1;
--dark-hl-5: #4FC1FF;
--light-hl-6: #AF00DB;
--dark-hl-6: #C586C0;
--light-hl-7: #001080;
Expand Down
2 changes: 1 addition & 1 deletion assets/main.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion assets/search.js

Large diffs are not rendered by default.

26 changes: 19 additions & 7 deletions assets/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
--light-color-ts-accessor: var(--light-color-ts-property);
--light-color-ts-get-signature: var(--light-color-ts-accessor);
--light-color-ts-set-signature: var(--light-color-ts-accessor);
/* object literal not included as it is not used and will be removed in 0.25 */
--light-color-ts-type-alias: #d51270;
/* reference not included as links will be colored with the kind that it points to */

Expand Down Expand Up @@ -72,7 +71,6 @@
--dark-color-ts-accessor: var(--dark-color-ts-property);
--dark-color-ts-get-signature: var(--dark-color-ts-accessor);
--dark-color-ts-set-signature: var(--dark-color-ts-accessor);
/* object literal not included as it is not used and will be removed in 0.25 */
--dark-color-ts-type-alias: #ff6492;
/* reference not included as links will be colored with the kind that it points to */

Expand Down Expand Up @@ -468,13 +466,12 @@ blockquote {
padding: 0 0 0 20px;
margin: 0;
}
.tsd-typography h4,
.tsd-typography .tsd-index-panel h3,
.tsd-index-panel .tsd-typography h3,
.tsd-typography h4,
.tsd-typography h5,
.tsd-typography h6 {
font-size: 1em;
margin: 0;
}
.tsd-typography h5,
.tsd-typography h6 {
Expand All @@ -485,6 +482,19 @@ blockquote {
.tsd-typography ol {
margin: 1em 0;
}
.tsd-typography table {
border-collapse: collapse;
border: none;
}
.tsd-typography td,
.tsd-typography th {
padding: 6px 13px;
border: 1px solid var(--color-accent);
}
.tsd-typography thead,
.tsd-typography tr:nth-child(even) {
background-color: var(--color-background-secondary);
}

.tsd-breadcrumb {
margin: 0;
Expand Down Expand Up @@ -909,8 +919,8 @@ a.tsd-index-link {
#tsd-search .results li.state {
display: none;
}
#tsd-search .results li.current,
#tsd-search .results li:hover {
#tsd-search .results li.current:not(.no-results),
#tsd-search .results li:hover:not(.no-results) {
background-color: var(--color-accent);
}
#tsd-search .results a {
Expand Down Expand Up @@ -1070,7 +1080,9 @@ ul.tsd-type-parameter-list h5 {
overflow: hidden;
opacity: 0.8;
height: 40px;
transition: opacity 0.1s, background-color 0.2s;
transition:
opacity 0.1s,
background-color 0.2s;
vertical-align: bottom;
cursor: pointer;
}
Expand Down
32 changes: 16 additions & 16 deletions classes/Lexer.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">Lexer</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/dc68e7b/src/lib/parser/Lexer.ts#L74">lib/parser/Lexer.ts:74</a></li></ul></aside>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/2414210/src/lib/parser/Lexer.ts#L74">lib/parser/Lexer.ts:74</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -56,24 +56,24 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Lexer.html" class="tsd-signature-type tsd-kind-class">Lexer</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/dc68e7b/src/lib/parser/Lexer.ts#L79">lib/parser/Lexer.ts:79</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/2414210/src/lib/parser/Lexer.ts#L79">lib/parser/Lexer.ts:79</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-private"><a id="buffer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>buffer</span><a href="#buffer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">buffer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/dc68e7b/src/lib/parser/Lexer.ts#L75">lib/parser/Lexer.ts:75</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/2414210/src/lib/parser/Lexer.ts#L75">lib/parser/Lexer.ts:75</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="parts" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>parts</span><a href="#parts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">parts</span><span class="tsd-signature-symbol">:</span> <a href="../types/Part.html" class="tsd-signature-type tsd-kind-type-alias">Part</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/dc68e7b/src/lib/parser/Lexer.ts#L76">lib/parser/Lexer.ts:76</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/2414210/src/lib/parser/Lexer.ts#L76">lib/parser/Lexer.ts:76</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="stream" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>stream</span><a href="#stream" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">stream</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">CharacterStream</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/dc68e7b/src/lib/parser/Lexer.ts#L77">lib/parser/Lexer.ts:77</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/2414210/src/lib/parser/Lexer.ts#L77">lib/parser/Lexer.ts:77</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="_iterator_" class="tsd-anchor"></a>
Expand All @@ -83,15 +83,15 @@ <h3 class="tsd-anchor-link"><span>[iterator]</span><a href="#_iterator_" aria-la
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="../types/PartIterator.html" class="tsd-signature-type tsd-kind-type-alias">PartIterator</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/dc68e7b/src/lib/parser/Lexer.ts#L83">lib/parser/Lexer.ts:83</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/2414210/src/lib/parser/Lexer.ts#L83">lib/parser/Lexer.ts:83</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="flushPart" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>flush<wbr/>Part</span><a href="#flushPart" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-private">
<li class="tsd-signature tsd-anchor-link" id="flushPart.flushPart-1"><span class="tsd-kind-call-signature">flush<wbr/>Part</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/PartIterator.html" class="tsd-signature-type tsd-kind-type-alias">PartIterator</a><a href="#flushPart.flushPart-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="../types/PartIterator.html" class="tsd-signature-type tsd-kind-type-alias">PartIterator</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/dc68e7b/src/lib/parser/Lexer.ts#L120">lib/parser/Lexer.ts:120</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/2414210/src/lib/parser/Lexer.ts#L120">lib/parser/Lexer.ts:120</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="pushPart" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>push<wbr/>Part</span><a href="#pushPart" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-private">
Expand All @@ -104,7 +104,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><span class="tsd-kind-parameter">part</span>: <a href="../types/Part.html" class="tsd-signature-type tsd-kind-type-alias">Part</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../types/PartIterator.html" class="tsd-signature-type tsd-kind-type-alias">PartIterator</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/dc68e7b/src/lib/parser/Lexer.ts#L114">lib/parser/Lexer.ts:114</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/skyra-project/tags/blob/2414210/src/lib/parser/Lexer.ts#L114">lib/parser/Lexer.ts:114</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down Expand Up @@ -165,14 +165,14 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/PartTagStart.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Part<wbr/>Tag<wbr/>Start</span></a></li>
<li><a href="../interfaces/SentencePartLiteral.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Sentence<wbr/>Part<wbr/>Literal</span></a></li>
<li><a href="../interfaces/SentencePartTag.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Sentence<wbr/>Part<wbr/>Tag</span></a></li>
<li><a href="../types/Part.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Part</span></a></li>
<li><a href="../types/PartIterator.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Part<wbr/>Iterator</span></a></li>
<li><a href="../types/PickData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Pick<wbr/>Data</span></a></li>
<li><a href="../types/PickMapKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Pick<wbr/>Map<wbr/>Key</span></a></li>
<li><a href="../types/PickMapValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Pick<wbr/>Map<wbr/>Value</span></a></li>
<li><a href="../types/ReadonlyPart.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Readonly<wbr/>Part</span></a></li>
<li><a href="../types/SentencePart.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Sentence<wbr/>Part</span></a></li>
<li><a href="../types/Part.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Part</span></a></li>
<li><a href="../types/PartIterator.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Part<wbr/>Iterator</span></a></li>
<li><a href="../types/PickData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Pick<wbr/>Data</span></a></li>
<li><a href="../types/PickMapKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Pick<wbr/>Map<wbr/>Key</span></a></li>
<li><a href="../types/PickMapValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Pick<wbr/>Map<wbr/>Value</span></a></li>
<li><a href="../types/ReadonlyPart.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Readonly<wbr/>Part</span></a></li>
<li><a href="../types/SentencePart.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Sentence<wbr/>Part</span></a></li>
<li><a href="../functions/parse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>parse</span></a></li></ul></nav></div></div></div>
<div class="tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
<p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
<div class="overlay"></div></body></html>
Loading

0 comments on commit 58d4b32

Please sign in to comment.