Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@DigitalFlow
DigitalFlow committed Jun 21, 2021
1 parent a089dac commit e692502
Show file tree
Hide file tree
Showing 48 changed files with 2,420 additions and 378 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.json
View file

Large diffs are not rendered by default.

28 changes: 23 additions & 5 deletions docs/classes/attribute.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Attribute.ts#L23">src/xrm/Attribute.ts:23</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/a089dac/src/xrm/Attribute.ts#L24">src/xrm/Attribute.ts:24</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -140,7 +140,7 @@ <h3>get<wbr>Required<wbr>Level</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Attribute.ts#L36">src/xrm/Attribute.ts:36</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/a089dac/src/xrm/Attribute.ts#L37">src/xrm/Attribute.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -174,7 +174,7 @@ <h3>get<wbr>Value</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Attribute.ts#L51">src/xrm/Attribute.ts:51</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/a089dac/src/xrm/Attribute.ts#L57">src/xrm/Attribute.ts:57</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -208,7 +208,7 @@ <h3>set<wbr>Value</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Attribute.ts#L81">src/xrm/Attribute.ts:81</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/a089dac/src/xrm/Attribute.ts#L92">src/xrm/Attribute.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -258,7 +258,7 @@ <h3>set<wbr>Values</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Attribute.ts#L123">src/xrm/Attribute.ts:123</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/a089dac/src/xrm/Attribute.ts#L139">src/xrm/Attribute.ts:139</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -393,6 +393,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-class">
<a href="entity.html" class="tsd-kind-icon">Entity</a>
</li>
<li class=" tsd-kind-class">
<a href="extendederror.html" class="tsd-kind-icon">Extended<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="form.html" class="tsd-kind-icon">Form</a>
</li>
Expand All @@ -402,6 +405,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-class">
<a href="portaluitest.html" class="tsd-kind-icon">Portal<wbr>UiTest</a>
</li>
<li class=" tsd-kind-class">
<a href="rethrownerror.html" class="tsd-kind-icon">Rethrown<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="section.html" class="tsd-kind-icon">Section</a>
</li>
Expand All @@ -423,6 +429,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-interface">
<a href="../interfaces/formidentifier.html" class="tsd-kind-icon">Form<wbr>Identifier</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/formnavigationsettings.html" class="tsd-kind-icon">Form<wbr>Navigation<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/navigationsettings.html" class="tsd-kind-icon">Navigation<wbr>Settings</a>
</li>
Expand All @@ -444,6 +453,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-function">
<a href="../globals.html#ensurexrmgetter" class="tsd-kind-icon">Ensure<wbr>Xrm<wbr>Getter</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#ispageelement" class="tsd-kind-icon">is<wbr>Page<wbr>Element</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#d365selectors" class="tsd-kind-icon">D365<wbr>Selectors</a>
</li>
Expand All @@ -464,6 +476,12 @@ <h2>Legend</h2>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
</ul>
</div>
</div>
</footer>
Expand Down
26 changes: 22 additions & 4 deletions docs/classes/button.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Button.ts#L35">src/xrm/Button.ts:35</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/a089dac/src/xrm/Button.ts#L35">src/xrm/Button.ts:35</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -139,7 +139,7 @@ <h3>click</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Button.ts#L79">src/xrm/Button.ts:79</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/a089dac/src/xrm/Button.ts#L79">src/xrm/Button.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -181,7 +181,7 @@ <h3>expand<wbr>More<wbr>Commands</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Button.ts#L47">src/xrm/Button.ts:47</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/a089dac/src/xrm/Button.ts#L47">src/xrm/Button.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -204,7 +204,7 @@ <h3>is<wbr>Visible</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Button.ts#L102">src/xrm/Button.ts:102</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/a089dac/src/xrm/Button.ts#L102">src/xrm/Button.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -326,6 +326,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-class">
<a href="entity.html" class="tsd-kind-icon">Entity</a>
</li>
<li class=" tsd-kind-class">
<a href="extendederror.html" class="tsd-kind-icon">Extended<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="form.html" class="tsd-kind-icon">Form</a>
</li>
Expand All @@ -335,6 +338,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-class">
<a href="portaluitest.html" class="tsd-kind-icon">Portal<wbr>UiTest</a>
</li>
<li class=" tsd-kind-class">
<a href="rethrownerror.html" class="tsd-kind-icon">Rethrown<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="section.html" class="tsd-kind-icon">Section</a>
</li>
Expand All @@ -356,6 +362,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-interface">
<a href="../interfaces/formidentifier.html" class="tsd-kind-icon">Form<wbr>Identifier</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/formnavigationsettings.html" class="tsd-kind-icon">Form<wbr>Navigation<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/navigationsettings.html" class="tsd-kind-icon">Navigation<wbr>Settings</a>
</li>
Expand All @@ -377,6 +386,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-function">
<a href="../globals.html#ensurexrmgetter" class="tsd-kind-icon">Ensure<wbr>Xrm<wbr>Getter</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#ispageelement" class="tsd-kind-icon">is<wbr>Page<wbr>Element</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#d365selectors" class="tsd-kind-icon">D365<wbr>Selectors</a>
</li>
Expand All @@ -397,6 +409,12 @@ <h2>Legend</h2>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
</ul>
</div>
</div>
</footer>
Expand Down
24 changes: 21 additions & 3 deletions docs/classes/control.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Control.ts#L24">src/xrm/Control.ts:24</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/a089dac/src/xrm/Control.ts#L25">src/xrm/Control.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -138,7 +138,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Control.ts#L37">src/xrm/Control.ts:37</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/a089dac/src/xrm/Control.ts#L38">src/xrm/Control.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -172,7 +172,7 @@ <h3>get<wbr>Options</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Control.ts#L57">src/xrm/Control.ts:57</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/a089dac/src/xrm/Control.ts#L63">src/xrm/Control.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -283,6 +283,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-class">
<a href="entity.html" class="tsd-kind-icon">Entity</a>
</li>
<li class=" tsd-kind-class">
<a href="extendederror.html" class="tsd-kind-icon">Extended<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="form.html" class="tsd-kind-icon">Form</a>
</li>
Expand All @@ -292,6 +295,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-class">
<a href="portaluitest.html" class="tsd-kind-icon">Portal<wbr>UiTest</a>
</li>
<li class=" tsd-kind-class">
<a href="rethrownerror.html" class="tsd-kind-icon">Rethrown<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="section.html" class="tsd-kind-icon">Section</a>
</li>
Expand All @@ -313,6 +319,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-interface">
<a href="../interfaces/formidentifier.html" class="tsd-kind-icon">Form<wbr>Identifier</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/formnavigationsettings.html" class="tsd-kind-icon">Form<wbr>Navigation<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/navigationsettings.html" class="tsd-kind-icon">Navigation<wbr>Settings</a>
</li>
Expand All @@ -334,6 +343,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-function">
<a href="../globals.html#ensurexrmgetter" class="tsd-kind-icon">Ensure<wbr>Xrm<wbr>Getter</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#ispageelement" class="tsd-kind-icon">is<wbr>Page<wbr>Element</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#d365selectors" class="tsd-kind-icon">D365<wbr>Selectors</a>
</li>
Expand All @@ -354,6 +366,12 @@ <h2>Legend</h2>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
</ul>
</div>
</div>
</footer>
Expand Down
20 changes: 19 additions & 1 deletion docs/classes/dialog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRM-OSS/D365-UI-Test/blob/c347198/src/xrm/Dialog.ts#L8">src/xrm/Dialog.ts:8</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/a089dac/src/xrm/Dialog.ts#L8">src/xrm/Dialog.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -199,6 +199,9 @@ <h4 class="tsd-returns-title">Returns <a href="dialog.html" class="tsd-signature
<li class=" tsd-kind-class">
<a href="entity.html" class="tsd-kind-icon">Entity</a>
</li>
<li class=" tsd-kind-class">
<a href="extendederror.html" class="tsd-kind-icon">Extended<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="form.html" class="tsd-kind-icon">Form</a>
</li>
Expand All @@ -208,6 +211,9 @@ <h4 class="tsd-returns-title">Returns <a href="dialog.html" class="tsd-signature
<li class=" tsd-kind-class">
<a href="portaluitest.html" class="tsd-kind-icon">Portal<wbr>UiTest</a>
</li>
<li class=" tsd-kind-class">
<a href="rethrownerror.html" class="tsd-kind-icon">Rethrown<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="section.html" class="tsd-kind-icon">Section</a>
</li>
Expand All @@ -229,6 +235,9 @@ <h4 class="tsd-returns-title">Returns <a href="dialog.html" class="tsd-signature
<li class=" tsd-kind-interface">
<a href="../interfaces/formidentifier.html" class="tsd-kind-icon">Form<wbr>Identifier</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/formnavigationsettings.html" class="tsd-kind-icon">Form<wbr>Navigation<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/navigationsettings.html" class="tsd-kind-icon">Navigation<wbr>Settings</a>
</li>
Expand All @@ -250,6 +259,9 @@ <h4 class="tsd-returns-title">Returns <a href="dialog.html" class="tsd-signature
<li class=" tsd-kind-function">
<a href="../globals.html#ensurexrmgetter" class="tsd-kind-icon">Ensure<wbr>Xrm<wbr>Getter</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#ispageelement" class="tsd-kind-icon">is<wbr>Page<wbr>Element</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#d365selectors" class="tsd-kind-icon">D365<wbr>Selectors</a>
</li>
Expand All @@ -270,6 +282,12 @@ <h2>Legend</h2>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
</ul>
</div>
</div>
</footer>
Expand Down
Loading

0 comments on commit e692502

Please sign in to comment.