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

public class | source

AbstractDoc

Direct Subclass:

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

Indirect Subclass:

TestFileDoc, TestFileDoc

Abstract Doc Class.

Test:

AbstractDoc:

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

Public Methods
public	['@_content']() for @_content, does not need to use this tag
public	['@_export']() for @_export, does not need to use this tag
public	['@_generator']() for @_generator, does not need to use this tag
public	['@_importPath']() for @_importPath, does not need to use this tag
public	['@_importStyle']() for @_importStyle, does not need to use this tag
public	['@_kind']() for @_kind, does not need to use this tag
public	['@_lineNumber']() for @_lineNumber, does not need to use this tag
public	['@_longname']() for @_longname, does not need to use this tag
public	['@_member']() for @_member.
public	['@_memberof']() for @_memberof, does not need to use this tag
public	['@_name']() for @_name, does not need to use this tag
public	['@_pseudoExport']() for @_pseudoExport, does not need to use this tag.
public	['@_static']() for @_static, does not need to use this tag
public	['@_undocument']() for @_undocument, does not need to use this tag
public	['@_unknown']() for @_unknown, does not need to use this tag
public	['@_variation']() for @_variation
public	['@abstract']() for @abstract.
public	['@access']() for @access, @public, @private, @protected
public	['@deprecated']() for @deprecated
public	['@desc']() for @desc
public	['@emits']() for @emits.
public	['@example']() for @example.
public	['@experimental']() for @experimental
public	['@ignore']() for @ignore.
public	['@listens']() for @listens.
public	['@override']() for @voerride.
public	['@param']() for @param.
public	['@private']() for @private
public	['@property']() for @property.
public	['@protected']() for @protected
public	['@public']() for @public
public	['@return']() for @return, @returns.
public	['@see']() for @see.
public	['@since']() for @since
public	['@throws']() for @throws.
public	['@todo']() for @todo.
public	['@type']() for @type.
public	['@version']() for @version

Private Methods
private	_apply() apply doc comment.
private	_find(names: string[]): Tag \| null find last tag.
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

Public Methods

public ['@_content']() source

for @_content, does not need to use this tag

public ['@_export']() source

for @_export, does not need to use this tag

public ['@_generator']() source

for @_generator, does not need to use this tag

public ['@_importPath']() source

for @_importPath, does not need to use this tag

public ['@_importStyle']() source

for @_importStyle, does not need to use this tag

public ['@_kind']() source

for @_kind, does not need to use this tag

public ['@_lineNumber']() source

for @_lineNumber, does not need to use this tag

public ['@_longname']() source

for @_longname, does not need to use this tag

public ['@_member']() source

for @_member.

public ['@_memberof']() source

for @_memberof, does not need to use this tag

public ['@_name']() source

for @_name, does not need to use this tag

public ['@_pseudoExport']() source

for @_pseudoExport, does not need to use this tag.

public ['@_static']() source

for @_static, does not need to use this tag

public ['@_undocument']() source

for @_undocument, does not need to use this tag

public ['@_unknown']() source

for @_unknown, does not need to use this tag

public ['@_variation']() source

for @_variation

public ['@abstract']() source

for @abstract.

public ['@access']() source

for @access, @public, @private, @protected

public ['@deprecated']() source

for @deprecated

public ['@desc']() source

for @desc

public ['@emits']() source

for @emits.

public ['@example']() source

for @example. possible multi tag.

public ['@experimental']() source

for @experimental

public ['@ignore']() source

for @ignore.

public ['@listens']() source

for @listens.

public ['@override']() source

for @voerride.

public ['@param']() source

for @param.

public ['@private']() source

for @private

public ['@property']() source

for @property.

public ['@protected']() source

for @protected

public ['@public']() source

for @public

public ['@return']() source

for @return, @returns.

public ['@see']() source

for @see. possible multi tag.

public ['@since']() source

for @since

public ['@throws']() source

for @throws.

public ['@todo']() source

for @todo. possible multi tag.

public ['@type']() source

for @type.

public ['@version']() source

for @version

Private Methods

private _apply() source

apply doc comment.

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

find last tag.

Params:

Name	Type	Attribute	Description
names	string[]		tag names.

Name

Type

Attribute

Description

names

string[]

tag names.

Return:

Tag | null

found tag.

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

find all tags.

Params:

Name	Type	Attribute	Description
names	string[]		tag names.

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.

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.

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.

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.

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.

Name

Type

Attribute

Description

name

string

identifier name.

Return:

string

resolved name.