Home Manual Reference Source Test Repository
import MemberDoc from 'esdoc/src/Doc/MemberDoc.js'
public class | source

MemberDoc

Extends:

AbstractDoc → MemberDoc

Doc Class from Member Expression AST node.

Method Summary

Public Methods
public

specify member to kind.

public

borrow {@link MethodDoc#@_memberof}

public

take out self name from self node

public

use static property in class

public

if @type is not exists, guess type by using self node

Private Methods
private

_apply()

apply own tag.

Inherited Summary

From class AbstractDoc
public get
private

_ast: *

private
private

_node: *

private
private

_value: *

public

for @_content, does not need to use this tag

public

for @_export, does not need to use this tag

public

for @_generator, does not need to use this tag

public

for @_importPath, does not need to use this tag

public

for @_importStyle, does not need to use this tag

public

for @_kind, does not need to use this tag

public

for @_lineNumber, does not need to use this tag

public

for @_longname, does not need to use this tag

public

for @_member.

public

for @_memberof, does not need to use this tag

public

for @_name, does not need to use this tag

public

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

public

for @_static, does not need to use this tag

public

for @_undocument, does not need to use this tag

public

for @_unknown, does not need to use this tag

public

for @_variation

public

for @abstract.

public

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

public

for @deprecated

public

for @desc

public

for @emits.

public

for @example.

public

for @experimental

public

for @ignore.

public

for @listens.

public

for @voerride.

public

for @param.

public

for @private

public

for @property.

public

for @protected

public

for @public

public

for @return, @returns.

public

for @see.

public

for @since

public

for @throws.

public

for @todo.

public

for @type.

public

for @version

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

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 Methods

public ['@_kind']() source

specify member to kind.

Override:

AbstractDoc#['@_kind']

public ['@_memberof']() source

borrow {@link MethodDoc#@_memberof}

Override:

AbstractDoc#['@_memberof']

public ['@_name']() source

take out self name from self node

Override:

AbstractDoc#['@_name']

public ['@_static']() source

use static property in class

Override:

AbstractDoc#['@_static']

public ['@type']() source

if @type is not exists, guess type by using self node

Override:

AbstractDoc#['@type']

Private Methods

private _apply() source

apply own tag.

Override:

AbstractDoc#_apply