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

public class | source

FunctionDoc

Extends:

AbstractDoc → FunctionDoc

Doc Class from Function declaration AST node.

Method Summary

Private Methods
private	_$async() use async property of self node.
private	_$generator() check generator property in self node
private	_$kind() specify `function` to kind.
private	_$memberof() take out self name from file path
private	_$name() take out self name from self node

Inherited Summary

From class AbstractDoc
public get	value: DocObject[]
private	_ast: *
private	_commentTags: *
private	_node: *
private	_pathResolver: *
private	_value: {}
protected	_apply() apply doc comment.
protected	_find(names: string[]): Tag \| null find last tag.
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.