Reference Source Test
import FunctionDoc from 'esdoc2/out/src/Doc/FunctionDoc.js'
public class | source

FunctionDoc

Extends:

AbstractDoc → FunctionDoc

Doc Class from Function declaration AST node.

Method Summary

Private Methods
private

use async property of self node.

private

check generator property in self node

private

_$kind()

specify function to kind.

private

take out self name from file path

private

_$name()

take out self name from self node

Inherited Summary

From class AbstractDoc
public get
private

_ast: *

private
private

_node: *

private
private

_value: {}

protected

_apply()

apply doc comment.

protected

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

find last tag.

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.

Private Methods

private _$async() source

use async property of self node.

Override:

AbstractDoc#_$async

private _$generator() source

check generator property in self node

Override:

AbstractDoc#_$generator

private _$kind() source

specify function to kind.

Override:

AbstractDoc#_$kind

private _$memberof() source

take out self name from file path

Override:

AbstractDoc#_$memberof

private _$name() source

take out self name from self node

Override:

AbstractDoc#_$name