Skip to content

Commit

Permalink
Updating documentation [fa06183]
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Jun 7, 2024
1 parent 0c498b7 commit 47b8359
Show file tree
Hide file tree
Showing 136 changed files with 2,002 additions and 1,241 deletions.
35 changes: 35 additions & 0 deletions assets/highlight.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@
--dark-hl-9: #4FC1FF;
--light-hl-10: #267F99;
--dark-hl-10: #4EC9B0;
--light-hl-11: #800000;
--dark-hl-11: #808080;
--light-hl-12: #800000;
--dark-hl-12: #569CD6;
--light-hl-13: #E50000;
--dark-hl-13: #9CDCFE;
--light-hl-14: #0000FF;
--dark-hl-14: #CE9178;
--light-hl-15: #CD3131;
--dark-hl-15: #F44747;
--light-code-background: #FFFFFF;
--dark-code-background: #1E1E1E;
}
Expand All @@ -37,6 +47,11 @@
--hl-8: var(--light-hl-8);
--hl-9: var(--light-hl-9);
--hl-10: var(--light-hl-10);
--hl-11: var(--light-hl-11);
--hl-12: var(--light-hl-12);
--hl-13: var(--light-hl-13);
--hl-14: var(--light-hl-14);
--hl-15: var(--light-hl-15);
--code-background: var(--light-code-background);
} }

Expand All @@ -52,6 +67,11 @@
--hl-8: var(--dark-hl-8);
--hl-9: var(--dark-hl-9);
--hl-10: var(--dark-hl-10);
--hl-11: var(--dark-hl-11);
--hl-12: var(--dark-hl-12);
--hl-13: var(--dark-hl-13);
--hl-14: var(--dark-hl-14);
--hl-15: var(--dark-hl-15);
--code-background: var(--dark-code-background);
} }

Expand All @@ -67,6 +87,11 @@
--hl-8: var(--light-hl-8);
--hl-9: var(--light-hl-9);
--hl-10: var(--light-hl-10);
--hl-11: var(--light-hl-11);
--hl-12: var(--light-hl-12);
--hl-13: var(--light-hl-13);
--hl-14: var(--light-hl-14);
--hl-15: var(--light-hl-15);
--code-background: var(--light-code-background);
}

Expand All @@ -82,6 +107,11 @@
--hl-8: var(--dark-hl-8);
--hl-9: var(--dark-hl-9);
--hl-10: var(--dark-hl-10);
--hl-11: var(--dark-hl-11);
--hl-12: var(--dark-hl-12);
--hl-13: var(--dark-hl-13);
--hl-14: var(--dark-hl-14);
--hl-15: var(--dark-hl-15);
--code-background: var(--dark-code-background);
}

Expand All @@ -96,4 +126,9 @@
.hl-8 { color: var(--hl-8); }
.hl-9 { color: var(--hl-9); }
.hl-10 { color: var(--hl-10); }
.hl-11 { color: var(--hl-11); }
.hl-12 { color: var(--hl-12); }
.hl-13 { color: var(--hl-13); }
.hl-14 { color: var(--hl-14); }
.hl-15 { color: var(--hl-15); }
pre, code { background: var(--code-background); }
2 changes: 1 addition & 1 deletion assets/search.js
View file

Large diffs are not rendered by default.

192 changes: 88 additions & 104 deletions classes/Deputy.html
View file

Large diffs are not rendered by default.

32 changes: 17 additions & 15 deletions classes/_internal_.AttributionNotice.html
View file

Large diffs are not rendered by default.

20 changes: 11 additions & 9 deletions classes/_internal_.AttributionNoticeRow.html
View file
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/1c5f541/src/modules/ante/models/AttributionNoticeRow.ts#L16">src/modules/ante/models/AttributionNoticeRow.ts:16</a></li></ul></aside>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/fa06183/src/modules/ante/models/AttributionNoticeRow.ts#L16">src/modules/ante/models/AttributionNoticeRow.ts:16</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 @@ -84,14 +84,14 @@ <h5><span class="tsd-kind-parameter">parent</span>: <span class="tsd-signature-t
<h4 class="tsd-returns-title">Returns <a href="_internal_.AttributionNoticeRow.html" class="tsd-signature-type tsd-kind-class">AttributionNoticeRow</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</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/1c5f541/src/modules/ante/models/AttributionNoticeRow.ts#L53">src/modules/ante/models/AttributionNoticeRow.ts:53</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/fa06183/src/modules/ante/models/AttributionNoticeRow.ts#L53">src/modules/ante/models/AttributionNoticeRow.ts:53</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-protected"><a id="_parent" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_parent</span><a href="#_parent" 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">_parent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type tsd-kind-type-parameter">T</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/1c5f541/src/modules/ante/models/AttributionNoticeRow.ts#L19">src/modules/ante/models/AttributionNoticeRow.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/fa06183/src/modules/ante/models/AttributionNoticeRow.ts#L19">src/modules/ante/models/AttributionNoticeRow.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>id</span><a href="#id" 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">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
Expand All @@ -100,7 +100,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/1c5f541/src/modules/ante/models/AttributionNoticeRow.ts#L29">src/modules/ante/models/AttributionNoticeRow.ts:29</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/fa06183/src/modules/ante/models/AttributionNoticeRow.ts#L29">src/modules/ante/models/AttributionNoticeRow.ts:29</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>
Expand All @@ -109,7 +109,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/1c5f541/src/modules/ante/models/AttributionNoticeRow.ts#L24">src/modules/ante/models/AttributionNoticeRow.ts:24</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/fa06183/src/modules/ante/models/AttributionNoticeRow.ts#L24">src/modules/ante/models/AttributionNoticeRow.ts:24</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="parent" class="tsd-anchor"></a>
Expand All @@ -121,7 +121,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-t

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/1c5f541/src/modules/ante/models/AttributionNoticeRow.ts#L33">src/modules/ante/models/AttributionNoticeRow.ts:33</a></li></ul></aside></li>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/fa06183/src/modules/ante/models/AttributionNoticeRow.ts#L33">src/modules/ante/models/AttributionNoticeRow.ts:33</a></li></ul></aside></li>
<li class="tsd-signature" id="parent.parent-2"><span class="tsd-signature-symbol">set</span> parent<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">newParent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Sets the parent. Automatically moves this template from one
Expand All @@ -138,7 +138,7 @@ <h5><span class="tsd-kind-parameter">newParent</span>: <span class="tsd-signatur
<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/1c5f541/src/modules/ante/models/AttributionNoticeRow.ts#L43">src/modules/ante/models/AttributionNoticeRow.ts:43</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/fa06183/src/modules/ante/models/AttributionNoticeRow.ts#L43">src/modules/ante/models/AttributionNoticeRow.ts:43</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="clone" class="tsd-anchor"></a>
Expand All @@ -160,7 +160,7 @@ <h4 class="tsd-returns-title">Returns <a href="_internal_.AttributionNoticeRow.h

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/1c5f541/src/modules/ante/models/AttributionNoticeRow.ts#L69">src/modules/ante/models/AttributionNoticeRow.ts:69</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/fa06183/src/modules/ante/models/AttributionNoticeRow.ts#L69">src/modules/ante/models/AttributionNoticeRow.ts:69</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 @@ -178,7 +178,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/1c5f541/src/modules/ante/models/AttributionNoticeRow.ts#L61">src/modules/ante/models/AttributionNoticeRow.ts:61</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/ChlodAlejandro/deputy/blob/fa06183/src/modules/ante/models/AttributionNoticeRow.ts#L61">src/modules/ante/models/AttributionNoticeRow.ts:61</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 @@ -219,6 +219,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../enums/_internal_.DeputyContributionSurveyRowState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Deputy<wbr/>Contribution<wbr/>Survey<wbr/>Row<wbr/>State</span></a></li>
<li><a href="../enums/_internal_.PortletNameView.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Portlet<wbr/>Name<wbr/>View</span></a></li>
<li><a href="../enums/_internal_.TripleCompletionAction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Triple<wbr/>Completion<wbr/>Action</span></a></li>
<li><a href="../enums/_internal_.WikiHeadingType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Wiki<wbr/>Heading<wbr/>Type</span></a></li>
<li><a href="../modules/_internal_.html#Missing"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>Missing</span></a></li>
<li><a href="../modules/_internal_.html#PresumptiveRemoval"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>Presumptive<wbr/>Removal</span></a></li>
<li><a href="../modules/_internal_.html#Unknown"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>Unknown</span></a></li>
Expand Down Expand Up @@ -321,6 +322,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/_internal_.SinglePageWorkflowDialogData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Single<wbr/>Page<wbr/>Workflow<wbr/>Dialog<wbr/>Data</span></a></li>
<li><a href="../interfaces/_internal_.TemplateData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Template<wbr/>Data</span></a></li>
<li><a href="../interfaces/_internal_.VisibleDisplayOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Visible<wbr/>Display<wbr/>Options</span></a></li>
<li><a href="../interfaces/_internal_.WikiHeading.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Wiki<wbr/>Heading</span></a></li>
<li><a href="../types/_internal_.ArrayOrNot.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>Array<wbr/>Or<wbr/>Not</span></a></li>
<li><a href="../types/_internal_.CleanParamsOption.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Clean<wbr/>Params<wbr/>Option</span></a></li>
<li><a href="../types/_internal_.CopyrightProblemsListingData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Copyright<wbr/>Problems<wbr/>Listing<wbr/>Data</span></a></li>
Expand Down
Loading

0 comments on commit 47b8359

Please sign in to comment.