Skip to content

Commit

Permalink
docs: Generate documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Sep 12, 2021
1 parent 0b2319c commit f7bdaa9
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 38 deletions.
2 changes: 1 addition & 1 deletion docs-master/assets/js/search.js
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs-master/classes/ArgumentContext.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1111,7 +1111,7 @@ <h3>current<wbr>Argument</h3>
<div class="tsd-signature tsd-kind-icon">current<wbr>Argument<span class="tsd-signature-symbol">:</span> <a href="CommandArgument.html" class="tsd-signature-type" data-tsd-kind="Class">CommandArgument</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/classes/contexts/ArgumentContext.ts#L15">source/src/classes/contexts/ArgumentContext.ts:15</a></li>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/classes/contexts/ArgumentContext.ts#L21">source/src/classes/contexts/ArgumentContext.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1142,7 +1142,7 @@ <h3>index</h3>
<div class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/classes/contexts/ArgumentContext.ts#L19">source/src/classes/contexts/ArgumentContext.ts:19</a></li>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/classes/contexts/ArgumentContext.ts#L25">source/src/classes/contexts/ArgumentContext.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -1197,7 +1197,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides <a href="CommandContext.html">CommandContext</a>.<a href="CommandContext.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/classes/contexts/ArgumentContext.ts#L26">source/src/classes/contexts/ArgumentContext.ts:26</a></li>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/classes/contexts/ArgumentContext.ts#L32">source/src/classes/contexts/ArgumentContext.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
37 changes: 31 additions & 6 deletions docs-master/interfaces/CommandHandler.LaunchCommandHandlerOptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ <h2>Index</h2>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandHandler.LaunchCommandHandlerOptions.html#addBotAndTeamOwnersToOwners"
class="tsd-kind-icon">add<wbr>Bot<wbr>And<wbr>Team<wbr>Owners<wbr>ToOwners</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandHandler.LaunchCommandHandlerOptions.html#clientOptions"
class="tsd-kind-icon">client<wbr>Options</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="CommandHandler.LaunchCommandHandlerOptions.html#cycleBetweenPresences"
Expand All @@ -111,13 +113,33 @@ <h3>Properties</h3>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="addBotAndTeamOwnersToOwners" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> add<wbr>Bot<wbr>And<wbr>Team<wbr>Owners<wbr>ToOwners</h3>
<div class="tsd-signature tsd-kind-icon">add<wbr>Bot<wbr>And<wbr>Team<wbr>Owners<wbr>ToOwners<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L156">source/src/CommandHandler.ts:156</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Whether to add the bot owner or the team members (if bot is from a team) to the <a href="../modules/CommandHandler.html#owners">owners</a>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>defaultvalue</dt>
<dd><p>true</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="clientOptions" class="tsd-anchor"></a>
<h3>client<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">client<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ClientOptions</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L154">source/src/CommandHandler.ts:154</a></li>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L160">source/src/CommandHandler.ts:160</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -132,7 +154,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> cycle<wbr>Between<wbr
<div class="tsd-signature tsd-kind-icon">cycle<wbr>Between<wbr>Presences<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L160">source/src/CommandHandler.ts:160</a></li>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L166">source/src/CommandHandler.ts:166</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -152,7 +174,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> cycle<wbr>Duration</h
<div class="tsd-signature tsd-kind-icon">cycle<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L166">source/src/CommandHandler.ts:166</a></li>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L172">source/src/CommandHandler.ts:172</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -172,7 +194,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> presence</h3>
<div class="tsd-signature tsd-kind-icon">presence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PresenceData</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L173">source/src/CommandHandler.ts:173</a></li>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L179">source/src/CommandHandler.ts:179</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -192,7 +214,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> presences</h3>
<div class="tsd-signature tsd-kind-icon">presences<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PresenceData</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L180">source/src/CommandHandler.ts:180</a></li>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L186">source/src/CommandHandler.ts:186</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -212,7 +234,7 @@ <h3>token</h3>
<div class="tsd-signature tsd-kind-icon">token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L184">source/src/CommandHandler.ts:184</a></li>
<li>Defined in <a href="https://github.com/Advanced-Command-Handler/Advanced-Command-Handler/tree/master/src/CommandHandler.ts#L190">source/src/CommandHandler.ts:190</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -259,6 +281,9 @@ <h3>token</h3>
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
<a href="CommandHandler.LaunchCommandHandlerOptions.html" class="tsd-kind-icon">Launch<wbr>Command<wbr>Handler<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="CommandHandler.LaunchCommandHandlerOptions.html#addBotAndTeamOwnersToOwners" class="tsd-kind-icon">add<wbr>Bot<wbr>And<wbr>Team<wbr>Owners<wbr>ToOwners</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="CommandHandler.LaunchCommandHandlerOptions.html#clientOptions" class="tsd-kind-icon">client<wbr>Options</a>
</li>
Expand Down
Loading

0 comments on commit f7bdaa9

Please sign in to comment.