Skip to content

Commit

Permalink
#27 updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@EduardoFernandes1410
EduardoFernandes1410 committed Dec 3, 2022
1 parent c83a072 commit e586619
Show file tree
Hide file tree
Showing 23 changed files with 68 additions and 53 deletions.
14 changes: 7 additions & 7 deletions docs/classes/Capabilities.Capabilities.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">Capabilities</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/deb5ad4/server/src/capabilities.ts#L7">server/src/capabilities.ts:7</a></li></ul></aside>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/capabilities.ts#L7">server/src/capabilities.ts:7</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 @@ -51,29 +51,29 @@ <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="Capabilities.Capabilities.html" class="tsd-signature-type" data-tsd-kind="Class">Capabilities</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/deb5ad4/server/src/capabilities.ts#L13">server/src/capabilities.ts:13</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/capabilities.ts#L13">server/src/capabilities.ts:13</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-kind-property tsd-parent-kind-class"><a id="hasConfigurationCapability" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>has<wbr/>Configuration<wbr/>Capability</span><a href="#hasConfigurationCapability" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">has<wbr/>Configuration<wbr/>Capability<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/objectionary/eo-vscode/blob/deb5ad4/server/src/capabilities.ts#L8">server/src/capabilities.ts:8</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/capabilities.ts#L8">server/src/capabilities.ts:8</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="hasDiagnosticRelatedInformationCapability" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>has<wbr/>Diagnostic<wbr/>Related<wbr/>Information<wbr/>Capability</span><a href="#hasDiagnosticRelatedInformationCapability" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">has<wbr/>Diagnostic<wbr/>Related<wbr/>Information<wbr/>Capability<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/objectionary/eo-vscode/blob/deb5ad4/server/src/capabilities.ts#L10">server/src/capabilities.ts:10</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/capabilities.ts#L10">server/src/capabilities.ts:10</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="hasDocumentSemanticTokensCapability" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>has<wbr/>Document<wbr/>Semantic<wbr/>Tokens<wbr/>Capability</span><a href="#hasDocumentSemanticTokensCapability" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">has<wbr/>Document<wbr/>Semantic<wbr/>Tokens<wbr/>Capability<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/objectionary/eo-vscode/blob/deb5ad4/server/src/capabilities.ts#L11">server/src/capabilities.ts:11</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/capabilities.ts#L11">server/src/capabilities.ts:11</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="hasWorkspaceFolderCapability" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>has<wbr/>Workspace<wbr/>Folder<wbr/>Capability</span><a href="#hasWorkspaceFolderCapability" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">has<wbr/>Workspace<wbr/>Folder<wbr/>Capability<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/objectionary/eo-vscode/blob/deb5ad4/server/src/capabilities.ts#L9">server/src/capabilities.ts:9</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/capabilities.ts#L9">server/src/capabilities.ts:9</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="initialize" class="tsd-anchor"></a>
Expand All @@ -88,7 +88,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>capabilities: <span class="tsd-signature-type">ClientCapabilities</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/deb5ad4/server/src/capabilities.ts#L20">server/src/capabilities.ts:20</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/capabilities.ts#L20">server/src/capabilities.ts:20</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
6 changes: 3 additions & 3 deletions docs/classes/ErrorListener.ErrorListener.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h4>Implements</h4>
<ul class="tsd-hierarchy">
<li><span class="tsd-signature-type">ANTLRErrorListener</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AntlrToken</span><span class="tsd-signature-symbol">&gt;</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/deb5ad4/server/src/errorListener.ts#L14">server/src/errorListener.ts:14</a></li></ul></aside>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/errorListener.ts#L14">server/src/errorListener.ts:14</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 @@ -59,7 +59,7 @@ <h3 class="tsd-anchor-link"><span>error<wbr/>List</span><a href="#errorList" ari
<div class="tsd-comment tsd-typography"><p>Array of errors detected during the parsing</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/deb5ad4/server/src/errorListener.ts#L19">server/src/errorListener.ts:19</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/errorListener.ts#L19">server/src/errorListener.ts:19</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="syntaxError" class="tsd-anchor"></a>
Expand All @@ -85,7 +85,7 @@ <h5>e: <span class="tsd-signature-type">undefined</span><span class="tsd-signatu
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Implementation of ANTLRErrorListener.syntaxError</p>
<ul>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/deb5ad4/server/src/errorListener.ts#L21">server/src/errorListener.ts:21</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/errorListener.ts#L21">server/src/errorListener.ts:21</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
10 changes: 5 additions & 5 deletions docs/classes/ParserError.ParserError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">ParserError</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/deb5ad4/server/src/parserError.ts#L6">server/src/parserError.ts:6</a></li></ul></aside>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/parserError.ts#L6">server/src/parserError.ts:6</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 @@ -67,24 +67,24 @@ <h5>msg: <span class="tsd-signature-type">string</span></h5>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="ParserError.ParserError.html" class="tsd-signature-type" data-tsd-kind="Class">ParserError</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/deb5ad4/server/src/parserError.ts#L18">server/src/parserError.ts:18</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/parserError.ts#L18">server/src/parserError.ts:18</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-kind-property tsd-parent-kind-class"><a id="column" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>column</span><a href="#column" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">column<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/objectionary/eo-vscode/blob/deb5ad4/server/src/parserError.ts#L8">server/src/parserError.ts:8</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/parserError.ts#L8">server/src/parserError.ts:8</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="line" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>line</span><a href="#line" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">line<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/objectionary/eo-vscode/blob/deb5ad4/server/src/parserError.ts#L7">server/src/parserError.ts:7</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/parserError.ts#L7">server/src/parserError.ts:7</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="msg" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>msg</span><a href="#msg" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">msg<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/objectionary/eo-vscode/blob/deb5ad4/server/src/parserError.ts#L9">server/src/parserError.ts:9</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/parserError.ts#L9">server/src/parserError.ts:9</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
12 changes: 6 additions & 6 deletions docs/classes/Processor.Processor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">Processor</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/deb5ad4/server/src/processor.ts#L14">server/src/processor.ts:14</a></li></ul></aside>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/processor.ts#L14">server/src/processor.ts:14</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,7 +56,7 @@ <h5>input: <span class="tsd-signature-type">string</span></h5>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Processor.Processor.html" class="tsd-signature-type" data-tsd-kind="Class">Processor</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/deb5ad4/server/src/processor.ts#L40">server/src/processor.ts:40</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/processor.ts#L40">server/src/processor.ts:40</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-kind-property tsd-parent-kind-class"><a id="inputStream" class="tsd-anchor"></a>
Expand All @@ -65,28 +65,28 @@ <h3 class="tsd-anchor-link"><span>input<wbr/>Stream</span><a href="#inputStream"
<div class="tsd-comment tsd-typography"><p>Text to be lexed and persed</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/deb5ad4/server/src/processor.ts#L19">server/src/processor.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/processor.ts#L19">server/src/processor.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="lexer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>lexer</span><a href="#lexer" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">lexer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ProgramLexer</span></div>
<div class="tsd-comment tsd-typography"><p>EO grammar lexer</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/deb5ad4/server/src/processor.ts#L24">server/src/processor.ts:24</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/processor.ts#L24">server/src/processor.ts:24</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="parser" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>parser</span><a href="#parser" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">parser<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ProgramParser</span></div>
<div class="tsd-comment tsd-typography"><p>EO grammar parser</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/deb5ad4/server/src/processor.ts#L34">server/src/processor.ts:34</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/processor.ts#L34">server/src/processor.ts:34</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="tokenStream" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>token<wbr/>Stream</span><a href="#tokenStream" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">token<wbr/>Stream<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommonTokenStream</span></div>
<div class="tsd-comment tsd-typography"><p>Stream of tokens provided by lexer</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/deb5ad4/server/src/processor.ts#L29">server/src/processor.ts:29</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/objectionary/eo-vscode/blob/c83a072/server/src/processor.ts#L29">server/src/processor.ts:29</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
Loading

0 comments on commit e586619

Please sign in to comment.