From e586619784c057ea6abea33b1fc96feb919e6419 Mon Sep 17 00:00:00 2001 From: EduardoFernandes1410 Date: Sun, 4 Dec 2022 01:41:10 +0300 Subject: [PATCH] #27 updated docs --- docs/classes/Capabilities.Capabilities.html | 14 +++++----- docs/classes/ErrorListener.ErrorListener.html | 6 ++--- docs/classes/ParserError.ParserError.html | 10 +++---- docs/classes/Processor.Processor.html | 12 ++++----- ...TokensProvider.SemanticTokensProvider.html | 26 +++++++++---------- docs/functions/ClientModule.activate.html | 2 +- docs/functions/ClientModule.deactivate.html | 2 +- .../Parser.antlrTypeNumToString.html | 2 +- docs/functions/Parser.getParserErrors.html | 2 +- docs/functions/Parser.getTokenTypes.html | 2 +- docs/functions/Parser.tokenize.html | 2 +- docs/index.html | 15 +++++++++++ .../DefaultSettings.DefaultSettings.html | 4 +-- docs/modules/Capabilities.html | 2 +- docs/modules/ClientModule.html | 2 +- docs/modules/DefaultSettings.html | 2 +- docs/modules/ErrorListener.html | 2 +- docs/modules/Parser.html | 4 +-- docs/modules/ParserError.html | 2 +- docs/modules/Processor.html | 2 +- docs/modules/SemanticTokensProvider.html | 2 +- docs/modules/ServerModule.html | 2 +- .../SemanticTokensProvider.VSCodeToken.html | 2 +- 23 files changed, 68 insertions(+), 53 deletions(-) diff --git a/docs/classes/Capabilities.Capabilities.html b/docs/classes/Capabilities.Capabilities.html index cf651f1..4dc8b41 100644 --- a/docs/classes/Capabilities.Capabilities.html +++ b/docs/classes/Capabilities.Capabilities.html @@ -21,7 +21,7 @@

Hierarchy

+
  • Defined in server/src/capabilities.ts:7
    • @@ -51,29 +51,29 @@

    constructor

    Returns Capabilities

    +
  • Defined in server/src/capabilities.ts:13

    • Properties

    hasConfigurationCapability

    hasConfigurationCapability: boolean
    +
  • Defined in server/src/capabilities.ts:8

    • hasDiagnosticRelatedInformationCapability

    hasDiagnosticRelatedInformationCapability: boolean
    +
  • Defined in server/src/capabilities.ts:10

    • hasDocumentSemanticTokensCapability

    hasDocumentSemanticTokensCapability: boolean
    +
  • Defined in server/src/capabilities.ts:11

    • hasWorkspaceFolderCapability

    hasWorkspaceFolderCapability: boolean
    +
  • Defined in server/src/capabilities.ts:9

    • Methods

    @@ -88,7 +88,7 @@

    Parameters

    capabilities: ClientCapabilities

    Returns void

    +
  • Defined in server/src/capabilities.ts:20
    • diff --git a/docs/classes/ErrorListener.ErrorListener.html b/docs/classes/ErrorListener.ErrorListener.html index 9d35e26..007f7d5 100644 --- a/docs/classes/ErrorListener.ErrorListener.html +++ b/docs/classes/ErrorListener.ErrorListener.html @@ -25,7 +25,7 @@

    Implements

    • ANTLRErrorListener<AntlrToken>
    +
  • Defined in server/src/errorListener.ts:14
    • @@ -59,7 +59,7 @@

    errorList

    Array of errors detected during the parsing

    +
  • Defined in server/src/errorListener.ts:19

    • Methods

    @@ -85,7 +85,7 @@
    e: undefinedReturns void
    +
  • Defined in server/src/errorListener.ts:21
    • diff --git a/docs/classes/ParserError.ParserError.html b/docs/classes/ParserError.ParserError.html index e0fa108..e62e027 100644 --- a/docs/classes/ParserError.ParserError.html +++ b/docs/classes/ParserError.ParserError.html @@ -21,7 +21,7 @@

    Hierarchy

    • ParserError
    +
  • Defined in server/src/parserError.ts:6
    • @@ -67,24 +67,24 @@
    msg: string

    Returns ParserError

    +
  • Defined in server/src/parserError.ts:18

    • Properties

    column

    column: number
    +
  • Defined in server/src/parserError.ts:8

    • line

    line: number
    +
  • Defined in server/src/parserError.ts:7

    • msg

    msg: string
    +
  • Defined in server/src/parserError.ts:9
    • diff --git a/docs/classes/Processor.Processor.html b/docs/classes/Processor.Processor.html index 5396b8a..b03a552 100644 --- a/docs/classes/Processor.Processor.html +++ b/docs/classes/Processor.Processor.html @@ -21,7 +21,7 @@

    Hierarchy

    • Processor
    +
  • Defined in server/src/processor.ts:14
    • @@ -56,7 +56,7 @@
    input: string

    Returns Processor

    +
  • Defined in server/src/processor.ts:40

    • Properties

    @@ -65,28 +65,28 @@

    inputStream

    Text to be lexed and persed

    +
  • Defined in server/src/processor.ts:19

    • lexer

    lexer: ProgramLexer

    EO grammar lexer

    +
  • Defined in server/src/processor.ts:24

    • parser

    parser: ProgramParser

    EO grammar parser

    +
  • Defined in server/src/processor.ts:34

    • tokenStream

    tokenStream: CommonTokenStream

    Stream of tokens provided by lexer

    +
  • Defined in server/src/processor.ts:29
    • diff --git a/docs/classes/SemanticTokensProvider.SemanticTokensProvider.html b/docs/classes/SemanticTokensProvider.SemanticTokensProvider.html index 401bed0..752a44a 100644 --- a/docs/classes/SemanticTokensProvider.SemanticTokensProvider.html +++ b/docs/classes/SemanticTokensProvider.SemanticTokensProvider.html @@ -24,7 +24,7 @@

    Hierarchy

    • SemanticTokensProvider
    +
  • Defined in server/src/semantics.ts:29
    • @@ -69,7 +69,7 @@
    capability: SemanticTokensClientCapabilitie

    Returns SemanticTokensProvider

    +
  • Defined in server/src/semantics.ts:53

    • Properties

    @@ -78,7 +78,7 @@

    legend

    The VSCode tokens types used in the EO semantic highlighting

    +
  • Defined in server/src/semantics.ts:34

    • tokenBuilders

    tokenBuilders: Map<string, SemanticTokensBuilder> = ...
    @@ -86,7 +86,7 @@

    tokenBuilders

    +
  • Defined in server/src/semantics.ts:40

    • tokenTypeMap

    tokenTypeMap: Map<string, string> = ...
    @@ -94,7 +94,7 @@

    tokenTypeMap

    +
  • Defined in server/src/semantics.ts:46

    • Methods

    @@ -118,7 +118,7 @@
    capability: SemanticTokensClientCapabilitie

    Returns SemanticTokensLegend

    +
  • Defined in server/src/semantics.ts:118

    • getTokenBuilder

    Returns SemanticTokensBuilder

    +
  • Defined in server/src/semantics.ts:168

    • populateBuilder

    Returns void

    +
  • Defined in server/src/semantics.ts:187

    • provideDeltas

    Returns SemanticTokens | SemanticTokensDelta

    +
  • Defined in server/src/semantics.ts:220

    • provideSemanticTokens

    Returns SemanticTokens

    +
  • Defined in server/src/semantics.ts:205

    • setMap

    +
  • Defined in server/src/semantics.ts:64

    • tokenize

    +
  • Defined in server/src/semantics.ts:143
    • diff --git a/docs/functions/ClientModule.activate.html b/docs/functions/ClientModule.activate.html index 0f3370c..4348a3b 100644 --- a/docs/functions/ClientModule.activate.html +++ b/docs/functions/ClientModule.activate.html @@ -36,7 +36,7 @@
    context: ExtensionContext

    Returns void

    +
  • Defined in client/src/extension.ts:28
    • diff --git a/docs/functions/ClientModule.deactivate.html b/docs/functions/ClientModule.deactivate.html index 2402b7f..cd2c494 100644 --- a/docs/functions/ClientModule.deactivate.html +++ b/docs/functions/ClientModule.deactivate.html @@ -29,7 +29,7 @@

    Returns

    Returns Thenable<void> | undefined

    +
  • Defined in client/src/extension.ts:77
    • diff --git a/docs/functions/Parser.antlrTypeNumToString.html b/docs/functions/Parser.antlrTypeNumToString.html index 599ed8e..a819e59 100644 --- a/docs/functions/Parser.antlrTypeNumToString.html +++ b/docs/functions/Parser.antlrTypeNumToString.html @@ -36,7 +36,7 @@
    num: number

    Returns string

    +
  • Defined in server/src/parser.ts:60
    • diff --git a/docs/functions/Parser.getParserErrors.html b/docs/functions/Parser.getParserErrors.html index 0f238bd..2442c84 100644 --- a/docs/functions/Parser.getParserErrors.html +++ b/docs/functions/Parser.getParserErrors.html @@ -35,7 +35,7 @@
    input: string

    Returns ParserError[]

    +
  • Defined in server/src/parser.ts:91
    • diff --git a/docs/functions/Parser.getTokenTypes.html b/docs/functions/Parser.getTokenTypes.html index cc52c41..8450dfc 100644 --- a/docs/functions/Parser.getTokenTypes.html +++ b/docs/functions/Parser.getTokenTypes.html @@ -28,7 +28,7 @@

    Returns

    Returns Set<string>

    +
  • Defined in server/src/parser.ts:69
    • diff --git a/docs/functions/Parser.tokenize.html b/docs/functions/Parser.tokenize.html index 6a83842..b3c8e17 100644 --- a/docs/functions/Parser.tokenize.html +++ b/docs/functions/Parser.tokenize.html @@ -35,7 +35,7 @@
    input: string

    Returns AntlrToken[]

    +
  • Defined in server/src/parser.ts:79
    • diff --git a/docs/index.html b/docs/index.html index 79c080e..07279ff 100644 --- a/docs/index.html +++ b/docs/index.html @@ -26,6 +26,21 @@

    eo

    ext install eolang.eo

    You can also install it from its page at Visual Studio Marketplace.

    + + +

    How to Contribute

    +     +

    Read the code documentation which can be found here

    +

    Clone the repository. Install node modules with:

    +
    $ npm install
+
    +

    Download grammar file and generate ANTLR4 parser with:

    +
    $ npm run fetch-and-build-grammar
+
    +

    Make changes on a new branch and create a pull request. To avoid frustration, run:

    +
    $ npm run linter
    $ npm run compile
+
    +

    before commiting.

    diff --git a/docs/interfaces/DefaultSettings.DefaultSettings.html b/docs/interfaces/DefaultSettings.DefaultSettings.html index 29cef64..36758c9 100644 --- a/docs/interfaces/DefaultSettings.DefaultSettings.html +++ b/docs/interfaces/DefaultSettings.DefaultSettings.html @@ -21,7 +21,7 @@

    Hierarchy

    • DefaultSettings
    +
  • Defined in server/src/defaultSettings.ts:5
    • @@ -37,7 +37,7 @@

    Properties

    maxNumberOfProblems

    maxNumberOfProblems: number
    +
  • Defined in server/src/defaultSettings.ts:6
    • diff --git a/docs/modules/Capabilities.html b/docs/modules/Capabilities.html index d0104e5..6d5ccf4 100644 --- a/docs/modules/Capabilities.html +++ b/docs/modules/Capabilities.html @@ -19,7 +19,7 @@

    Module Capabilities

    Defines the capabilities of the Language Server

    +
  • Defined in server/src/capabilities.ts:6
    • diff --git a/docs/modules/ClientModule.html b/docs/modules/ClientModule.html index da9f328..29919d6 100644 --- a/docs/modules/ClientModule.html +++ b/docs/modules/ClientModule.html @@ -19,7 +19,7 @@

    Module ClientModule

    The Client Module for the extension.

    +
  • Defined in client/src/extension.ts:6
    • diff --git a/docs/modules/DefaultSettings.html b/docs/modules/DefaultSettings.html index c483763..cd6e5c6 100644 --- a/docs/modules/DefaultSettings.html +++ b/docs/modules/DefaultSettings.html @@ -19,7 +19,7 @@

    Module DefaultSettings

    Default setting properties for the Language Server

    +
  • Defined in server/src/defaultSettings.ts:5
    • diff --git a/docs/modules/ErrorListener.html b/docs/modules/ErrorListener.html index b3b3503..67d88f7 100644 --- a/docs/modules/ErrorListener.html +++ b/docs/modules/ErrorListener.html @@ -19,7 +19,7 @@

    Module ErrorListener

    Provides the errors detected during the parsing of an input program.

    +
  • Defined in server/src/errorListener.ts:6
    • diff --git a/docs/modules/Parser.html b/docs/modules/Parser.html index 5c05688..fc4b9d7 100644 --- a/docs/modules/Parser.html +++ b/docs/modules/Parser.html @@ -16,10 +16,10 @@
  • Parser

    • Module Parser

    -

    Performs the parsing of the text document.

    +

    Performs the parsing of the text document and reports on errors found.

    +
  • Defined in server/src/parser.ts:6
    • diff --git a/docs/modules/ParserError.html b/docs/modules/ParserError.html index 099bd83..d72b073 100644 --- a/docs/modules/ParserError.html +++ b/docs/modules/ParserError.html @@ -19,7 +19,7 @@

    Module ParserError

    VSCode parsing error message

    +
  • Defined in server/src/parserError.ts:6
    • diff --git a/docs/modules/Processor.html b/docs/modules/Processor.html index fc94191..5d9fc81 100644 --- a/docs/modules/Processor.html +++ b/docs/modules/Processor.html @@ -19,7 +19,7 @@

    Module Processor

    Runs the EO lexer and parser on a given text

    +
  • Defined in server/src/processor.ts:6
    • diff --git a/docs/modules/SemanticTokensProvider.html b/docs/modules/SemanticTokensProvider.html index 4775c5a..cf15a36 100644 --- a/docs/modules/SemanticTokensProvider.html +++ b/docs/modules/SemanticTokensProvider.html @@ -19,7 +19,7 @@

    Module SemanticTokensProvider

    Performs the semantic highlighting if the documents.

    +
  • Defined in server/src/semantics.ts:6
    • diff --git a/docs/modules/ServerModule.html b/docs/modules/ServerModule.html index 0af80b0..a4340ae 100644 --- a/docs/modules/ServerModule.html +++ b/docs/modules/ServerModule.html @@ -19,7 +19,7 @@

    Module ServerModule

    The Server Module for the extension.

    +
  • Defined in server/src/server.ts:6
    • diff --git a/docs/types/SemanticTokensProvider.VSCodeToken.html b/docs/types/SemanticTokensProvider.VSCodeToken.html index 7187b35..49bbaed 100644 --- a/docs/types/SemanticTokensProvider.VSCodeToken.html +++ b/docs/types/SemanticTokensProvider.VSCodeToken.html @@ -34,7 +34,7 @@
    tokenModifier:
    tokenType: number
    +
  • Defined in server/src/semantics.ts:18