Manual Reference Source Test
import AbstractDoc from 'esdoc/out/src/Doc/AbstractDoc.js'
public class | source

AbstractDoc

Abstract Doc Class.

TODO:

  • rename this class name.

Constructor Summary

Public Constructor
public

constructor(ast: AST, node: ASTNode, pathResolver: PathResolver, commentTags: Tag[])

create instance.

Member Summary

Public Members
public get
Private Members
private

_ast: *

private
private

_node: *

private
private

_value: {}

Method Summary

Protected Methods
protected

_apply()

apply doc comment.

protected

_find(names: string[]): Tag | null

find last tag.

Private Methods
private

decide abstract.

private

decide access.

private abstract

decide async.

private abstract

decide content.

private

decide decorator.

private

decide deprecated.

private

_$desc()

decide description.

private

decide emits.

private

decide examples.

private

decide experimental.

private

decide export.

private abstract

decide generator.

private

decide ignore.

private

decide importPath.

private

decide importStyle.

private abstract

_$kind()

decide kind.

private

decide lineNumber.

private

decide listens.

private

decide longname.

private abstract

decide member.

private abstract

decide memberof.

private abstract

_$name()

decide name

private

decide override.

private

decide param.

private

avoid unknown tag.

private

decide property.

private

avoid unknown tag.

private

decide pseudoExport.

private

avoid unknown tag.

private

decide return.

private

_$see()

decide see.

private

decide since.

private

decide static.

private

decide throws.

private

_$todo()

decide todo.

private

_$type()

decide type.

private

decide undocument with internal tag.

private

decide unknown.

private abstract

decide variation.

private

decide version.

private

_findAll(names: string[]): Tag[] | null

find all tags.

private

_findAllTagValues(names: string[]): *[] | null

find all tag values.

private

find class in same file, import or external.

private

_findTagValue(names: string[]): * | null

find ta value.

private

flatten member expression property name.

private

resolve long name.

Public Constructors

public constructor(ast: AST, node: ASTNode, pathResolver: PathResolver, commentTags: Tag[]) source

create instance.

Params:

NameTypeAttributeDescription
ast AST

this is AST that contains this doc.

node ASTNode

this is self node.

pathResolver PathResolver

this is file path resolver that contains this doc.

commentTags Tag[]

this is tags that self node has.

Public Members

public get value: DocObject[] source

Private Members

private _ast: * source

private _commentTags: * source

private _node: * source

private _pathResolver: * source

private _value: {} source

Protected Methods

protected _apply() source

apply doc comment.

protected _find(names: string[]): Tag | null source

find last tag.

Params:

NameTypeAttributeDescription
names string[]

tag names.

Return:

Tag | null

found tag.

Private Methods

private _$abstract() source

decide abstract.

private _$access() source

decide access. process also @public, @private and @protected.

private abstract _$async() source

decide async.

private abstract _$content() source

decide content.

private _$decorator() source

decide decorator.

private _$deprecated() source

decide deprecated.

private _$desc() source

decide description.

private _$emits() source

decide emits.

private _$example() source

decide examples.

private _$experimental() source

decide experimental.

private _$export() source

decide export.

private abstract _$generator() source

decide generator.

private _$ignore() source

decide ignore.

private _$importPath() source

decide importPath.

private _$importStyle() source

decide importStyle.

private abstract _$kind() source

decide kind.

private _$lineNumber() source

decide lineNumber.

private _$listens() source

decide listens.

private _$longname() source

decide longname.

private abstract _$member() source

decide member.

private abstract _$memberof() source

decide memberof.

private abstract _$name() source

decide name

private _$override() source

decide override.

private _$param() source

decide param.

private _$private() source

avoid unknown tag.

private _$property() source

decide property.

private _$protected() source

avoid unknown tag.

private _$pseudoExport() source

decide pseudoExport.

private _$public() source

avoid unknown tag.

private _$return() source

decide return.

private _$see() source

decide see.

private _$since() source

decide since.

private _$static() source

decide static.

private _$throws() source

decide throws.

private _$todo() source

decide todo.

private _$type() source

decide type.

private _$undocument() source

decide undocument with internal tag.

private _$unknown() source

decide unknown.

private abstract _$variation() source

decide variation.

TODO:

  • implements [email protected]`.

private _$version() source

decide version.

private _findAll(names: string[]): Tag[] | null source

find all tags.

Params:

NameTypeAttributeDescription
names string[]

tag names.

Return:

Tag[] | null

found tags.

private _findAllTagValues(names: string[]): *[] | null source

find all tag values.

Params:

NameTypeAttributeDescription
names string[]

tag names.

Return:

*[] | null

found values.

private _findClassLongname(className: string): string source

find class in same file, import or external.

Params:

NameTypeAttributeDescription
className string

target class name.

Return:

string

found class long name.

private _findTagValue(names: string[]): * | null source

find ta value.

Params:

NameTypeAttributeDescription
names string[]

tag names.

Return:

* | null

found value.

private _flattenMemberExpression(node: ASTNode): string source

flatten member expression property name. if node structure is [foo [bar [baz [this] ] ] ], flatten is this.baz.bar.foo

Params:

NameTypeAttributeDescription
node ASTNode

target member expression node.

Return:

string

flatten property.

private _resolveLongname(name: string): string source

resolve long name. if the name relates import path, consider import path.

Params:

NameTypeAttributeDescription
name string

identifier name.

Return:

string

resolved name.