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

public class | source

ClassDoc

Extends:

AbstractDoc → ClassDoc

Doc Class from Class Declaration AST node.

Test:

ClassDoc:

Method Summary

Public Methods
public	['@_kind']() specify `class` to kind.
public	['@_memberof']() take out self memberof from file path.
public	['@_name']() take out self name from self node
public	['@extends']() for @extends, does not need to use this tag.
public	['@implements']() for @implements
public	['@interface']() for @interface

Private Methods
private	_apply() apply own tag.
private	_readSelection(filePath: string, line: number, startColumn: number, endColumn: number): string read selection text in file.

Inherited Summary

From class AbstractDoc
public get	value: DocObject[]
private	_ast: *
private	_commentTags: *
private	_node: *
private	_pathResolver: *
private	_value: *
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	_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 Methods

public ['@_kind']() source

specify class to kind.

Override:

AbstractDoc#['@_kind']

public ['@_memberof']() source

take out self memberof from file path.

Override:

AbstractDoc#['@_memberof']

public ['@_name']() source

take out self name from self node

Override:

AbstractDoc#['@_name']

public ['@extends']() source

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

public ['@implements']() source

for @implements

public ['@interface']() source

for @interface

Private Methods

private _apply() source

apply own tag.

Override:

AbstractDoc#_apply

private _readSelection(filePath: string, line: number, startColumn: number, endColumn: number): string source

read selection text in file.

Params:

Name	Type	Attribute	Description
filePath	string		target file full path.
line	number		line number (one origin).
startColumn	number		start column number (one origin).
endColumn	number		end column number (one origin).

Return:

string

selection text