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

TestDoc

Extends:

AbstractDoc → TestDoc

Doc Class from test code file.

Method Summary

Public Methods
public

use name property of self node.

public

set memberof to use parent test nod and file path.

public

set name and testId from special esdoc property.

public

set describe by using test node arguments.

public

for @testTarget.

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

use name property of self node.

Override:

AbstractDoc#['@_kind']

public ['@_memberof']() source

set memberof to use parent test nod and file path.

Override:

AbstractDoc#['@_memberof']

public ['@_name']() source

set name and testId from special esdoc property.

Override:

AbstractDoc#['@_name']

public ['@desc']() source

set describe by using test node arguments.

Override:

AbstractDoc#['@desc']

public ['@testTarget']() source

for @testTarget.

Private Methods

private _apply() source

apply own tag.

Override:

AbstractDoc#_apply