Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Python

Python, extends WorkShop.

export
class

Python

extends

{WorkShop}

Hierarchy

Index

Constructors

constructor

  • new Python(syntaxFile: string, docType: string): Python

Properties

Protected block

block: string[] = []

The wanted block from the parser.

type

{string[]}

memberof

WorkShop

Protected config

The configuration of the template file in use.

type

{IDefaultObject}

memberof

WorkShop

Protected docRows

docRows: string

The document rows.

type

{string}

memberof

WorkShop

Protected document

document: vs.TextDocument = vs.window.activeTextEditor.document

The active text editor document..

type

{vs.TextDocument}

memberof

WorkShop

Protected editor

editor: vs.TextEditor = vs.window.activeTextEditor

The active text editor.

type

{vs.TextEditor}

memberof

WorkShop

Protected parse

The Python parser.

type

{PythonParse}

memberof

Python

Protected position

position: vs.Position = vs.window.activeTextEditor.selection.active

The cursor's current position within the WorkShop.document

type

{vs.Position}

memberof

WorkShop

Protected syntaxFile

syntaxFile: string

The template file text.

type

{string}

memberof

WorkShop

Protected vars

The available variables.

type

{ISyntaxVariable}

memberof

WorkShop

Methods

Protected correctlyPlacedFunction

  • correctlyPlacedFunction(functionLineIndex: string): boolean

generate

  • generate(docType: string, config: any, onEnter: boolean): Promise<void>
  • Start generateFunction, run different functions based on docType.

    memberof

    WorkShop

    Parameters

    • docType: string

      The type of documentation to make.

    • config: any

      The configuration for this specific documentation.

    • onEnter: boolean

      If enter activated the extension.

    Returns Promise<void>

    Promise to return a void.

Protected getComment

  • getComment(variable: string): string | undefined
  • Get the comment based on the language and the variable wanted.

    memberof

    WorkShop

    Parameters

    • variable: string

      What comment wanted.

    Returns string | undefined

    The comment string.

Protected getCurrentColumn

  • getCurrentColumn(index: number): number

Protected getVariables

Generated using TypeDoc