Skip to content

Commit

Permalink
Updating documentation [3a7e0dd]
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Apr 24, 2024
1 parent 01ade6d commit a4f1936
Show file tree
Hide file tree
Showing 133 changed files with 1,192 additions and 1,173 deletions.
2 changes: 1 addition & 1 deletion assets/search.js

Large diffs are not rendered by default.

151 changes: 83 additions & 68 deletions classes/Deputy.html

Large diffs are not rendered by default.

30 changes: 15 additions & 15 deletions classes/_internal_.AttributionNotice.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ <h4>Implements</h4>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/_internal_.AttributionNoticePageGenerator.html" class="tsd-signature-type tsd-kind-interface">AttributionNoticePageGenerator</a></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L13">src/modules/ante/models/AttributionNotice.ts:13</a></li></ul></aside>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L13">src/modules/ante/models/AttributionNotice.ts:13</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 @@ -91,7 +91,7 @@ <h4 class="tsd-returns-title">Returns <a href="_internal_.AttributionNotice.html
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Overrides EventTarget.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L57">src/modules/ante/models/AttributionNotice.ts:57</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L57">src/modules/ante/models/AttributionNotice.ts:57</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"><a id="id" class="tsd-anchor"></a>
Expand All @@ -101,15 +101,15 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L28">src/modules/ante/models/AttributionNotice.ts:28</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L28">src/modules/ante/models/AttributionNotice.ts:28</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>A unique name for this template. Derived from the Parsoid <code>about</code> for its node.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L24">src/modules/ante/models/AttributionNotice.ts:24</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L24">src/modules/ante/models/AttributionNotice.ts:24</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="node" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>node</span><a href="#node" 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">node</span><span class="tsd-signature-symbol">:</span> <a href="_internal_.CTEParsoidTransclusionTemplateNode.html" class="tsd-signature-type tsd-kind-class">CTEParsoidTransclusionTemplateNode</a></div>
Expand All @@ -118,7 +118,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L20">src/modules/ante/models/AttributionNotice.ts:20</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L20">src/modules/ante/models/AttributionNotice.ts:20</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member"><a id="element" class="tsd-anchor"></a>
Expand All @@ -130,7 +130,7 @@ <h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/doc

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L39">src/modules/ante/models/AttributionNotice.ts:39</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L39">src/modules/ante/models/AttributionNotice.ts:39</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="i" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>i</span><a href="#i" 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">
Expand All @@ -141,7 +141,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</s

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L47">src/modules/ante/models/AttributionNotice.ts:47</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L47">src/modules/ante/models/AttributionNotice.ts:47</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="parsoid" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>parsoid</span><a href="#parsoid" 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">
Expand All @@ -151,7 +151,7 @@ <h4 class="tsd-returns-title">Returns <a href="_internal_.CTEParsoidDocument.htm

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L33">src/modules/ante/models/AttributionNotice.ts:33</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L33">src/modules/ante/models/AttributionNotice.ts:33</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="accessTemplateData" class="tsd-anchor"></a>
Expand All @@ -173,7 +173,7 @@ <h5><span class="tsd-kind-parameter">callback</span>: <a href="../types/_interna
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L72">src/modules/ante/models/AttributionNotice.ts:72</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L72">src/modules/ante/models/AttributionNotice.ts:72</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code> <span>destroy</span><a href="#destroy" 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">
Expand All @@ -185,7 +185,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L131">src/modules/ante/models/AttributionNotice.ts:131</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L131">src/modules/ante/models/AttributionNotice.ts:131</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="generatePage" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code> <span>generate<wbr/>Page</span><a href="#generatePage" 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">
Expand All @@ -203,7 +203,7 @@ <h4 class="tsd-returns-title">Returns <a href="../interfaces/_internal_.Attribut
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_internal_.AttributionNoticePageGenerator.html">AttributionNoticePageGenerator</a>.<a href="../interfaces/_internal_.AttributionNoticePageGenerator.html#generatePage">generatePage</a></p>
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L137">src/modules/ante/models/AttributionNotice.ts:137</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L137">src/modules/ante/models/AttributionNotice.ts:137</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="generatePreview" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>generate<wbr/>Preview</span><a href="#generatePreview" 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">
Expand All @@ -214,7 +214,7 @@ <h3 class="tsd-anchor-link"><span>generate<wbr/>Preview</span><a href="#generate
<h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">summary</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L168">src/modules/ante/models/AttributionNotice.ts:168</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L168">src/modules/ante/models/AttributionNotice.ts:168</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="parse" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code> <span>parse</span><a href="#parse" 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">
Expand All @@ -228,7 +228,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L120">src/modules/ante/models/AttributionNotice.ts:120</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L120">src/modules/ante/models/AttributionNotice.ts:120</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="save" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code> <span>save</span><a href="#save" 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">
Expand All @@ -239,7 +239,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L125">src/modules/ante/models/AttributionNotice.ts:125</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L125">src/modules/ante/models/AttributionNotice.ts:125</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="toWikitext" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>to<wbr/>Wikitext</span><a href="#toWikitext" 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">
Expand All @@ -252,7 +252,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/0cff0fa/src/modules/ante/models/AttributionNotice.ts#L146">src/modules/ante/models/AttributionNotice.ts:146</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/3a7e0dd/src/modules/ante/models/AttributionNotice.ts#L146">src/modules/ante/models/AttributionNotice.ts:146</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
Loading

0 comments on commit a4f1936

Please sign in to comment.