import AbstractDoc from 'esdoc/out/src/Doc/AbstractDoc.js'

public class | source

AbstractDoc

Direct Subclass:

AssignmentDoc, ClassDoc, ClassPropertyDoc, ExternalDoc, FileDoc, FunctionDoc, MemberDoc, MethodDoc, TypedefDoc, VariableDoc

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	value: DocObject[]

Private Members
private	_ast: *
private	_commentTags: *
private	_node: *
private	_pathResolver: *
private	_value: {}

Method Summary

Protected Methods
protected	_apply() apply doc comment.
protected	_find(names: string[]): Tag \| null find last tag.

Private Methods
private	_$abstract() decide `abstract`.
private	_$access() decide `access`.
private abstract	_$async() decide `async`.
private abstract	_$content() decide `content`.
private	_$decorator() decide `decorator`.
private	_$deprecated() decide `deprecated`.
private	_$desc() decide `description`.
private	_$emits() decide `emits`.
private	_$example() decide `examples`.
private	_$experimental() decide `experimental`.
private	_$export() decide `export`.
private abstract	_$generator() decide `generator`.
private	_$ignore() decide `ignore`.
private	_$importPath() decide `importPath`.
private	_$importStyle() decide `importStyle`.
private abstract	_$kind() decide `kind`.
private	_$lineNumber() decide `lineNumber`.
private	_$listens() decide `listens`.
private	_$longname() decide `longname`.
private abstract	_$member() decide `member`.
private abstract	_$memberof() decide `memberof`.
private abstract	_$name() decide `name`
private	_$override() decide `override`.
private	_$package() avoid unknown tag.
private	_$param() decide `param`.
private	_$private() avoid unknown tag.
private	_$property() decide `property`.
private	_$protected() avoid unknown tag.
private	_$pseudoExport() decide `pseudoExport`.
private	_$public() avoid unknown tag.
private	_$return() decide `return`.
private	_$see() decide `see`.
private	_$since() decide `since`.
private	_$static() decide `static`.
private	_$throws() decide `throws`.
private	_$todo() decide `todo`.
private	_$type() decide `type`.
private	_$undocument() decide `undocument` with internal tag.
private	_$unknown() decide `unknown`.
private abstract	_$variation() decide `variation`.
private	_$version() decide `version`.
private	_findAll(names: string[]): Tag[] \| null find all tags.
private	_findAllTagValues(names: string[]): *[] \| null find all tag values.
private	_findClassLongname(className: string): string find class in same file, import or external.
private	_findTagValue(names: string[]): * \| null find ta value.
private	_flattenMemberExpression(node: ASTNode): string flatten member expression property name.
private	_resolveLongname(name: string): string resolve long name.

Public Constructors

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

create instance.

Params:

Name	Type	Attribute	Description
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:

Name	Type	Attribute	Description
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, @protected and @package.

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 _$package() source

avoid unknown tag.

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 `@variation`.

private _$version() source

decide version.

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

find all tags.

Params:

Name	Type	Attribute	Description
names	string[]		tag names.

Return:

Tag[] | null

found tags.

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

find all tag values.

Params:

Name	Type	Attribute	Description
names	string[]		tag names.

Return:

*[] | null

found values.

private _findClassLongname(className: string): string source

find class in same file, import or external.

Params:

Name	Type	Attribute	Description
className	string		target class name.

Return:

string

found class long name.

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

find ta value.

Params:

Name	Type	Attribute	Description
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:

Name	Type	Attribute	Description
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:

Name	Type	Attribute	Description
name	string		identifier name.

Return:

string

resolved name.