Skip to main content
Module

x/docable/src/compilers/json_compiler.ts>default

An open-source doc block parser for generating documenation as JSON.
crookse/docable
Latest
class default
import { default } from "https://deno.land/x/docable@v0.1.3/src/compilers/json_compiler.ts";

Properties

protected
current_file: string
protected
decoder: TextDecoder
protected
parsed: any
protected
parsing_members_only_file: boolean

Is the compiler currently parsing a file with the @members-only annotation?

protected
re__member_names: string
protected
re_description_stop_points: RegExp
protected
re_export: RegExp
protected
re_for_all_members: RegExp
protected
re_ignore_block: RegExp
protected
re_ignore_line: RegExp
protected
re_is_class: RegExp
protected
re_is_const: RegExp
protected
re_is_constructor: RegExp
protected
re_is_enum: RegExp
protected
re_is_function: RegExp
protected
re_is_interface: RegExp
protected
re_is_method: RegExp
protected
re_is_property: RegExp
protected
re_members_only: RegExp
protected
re_namespace: RegExp

Methods

protected
getAndCreateNamespace(docBlock: string): string
protected
getAnnotation(annotation: string, docBlock: string): any
protected
getDescription(textBlock: string): string[]
protected
getDescriptionInParagraphs(textBlock: string): string[]
protected
getDocBlockDataForConst(text: string): any
protected
getDocBlockDataForEnum(text: string): any
protected
getDocBlockDataForFunction(text: string): any
protected
getDocBlockDataForInterface(text: string): any
protected
getDocBlockDataForMethod(text: string): any
protected
getDocBlockDataForProperty(text: string): any
protected
getMemberName(text: string, textType?: string): string
protected
getMemberNameInterface(
textByLine,
index?,
line?,
)
protected
getMemberNameMethod(
textByLine,
index?,
line?,
)
protected
getNameOfConst(text: string): string
protected
getNameOfEnum(text: string): string
protected
getNameOfFunction(text: string): string
protected
getNameOfProperty(text: string): string
protected
getSignatureOfFunction(text: string): string
protected
getSignatureOfInterface(text: string): string
protected
getSignatureOfMethod(text: string): string
protected
getSignatureOfProperty(text: string): string
protected
isMemberExported(memberType: string, text: string): boolean

Is the member exported?

protected
parseClassFile(fileContents)
protected
parseMembersOnlyFile(fileContents)
compile(files: string[]): any
getSection(annotation: string, docBlock: string): any