import ClassDocBuilder from 'esdoc/src/Publisher/Builder/ClassDocBuilder.js'

public class | source

ClassDocBuilder

Extends:

DocBuilder → ClassDocBuilder

Class Output Builder class.

Test:

Method Summary

Public Methods
public	exec(callback: function(html: string, filePath: string)) execute building output.

Private Methods
private	_buildClassDoc(doc: DocObject): IceCap build class output.
private	_buildDirectSubclassHTML(doc: DocObject): string build direct subclass list.
private	_buildExpressionExtendsHTML(doc: DocObject): string build expression extends html.
private	_buildExtendsChainHTML(doc: DocObject): string build class ancestor extends chain.
private	_buildIndirectSubclassHTML(doc: DocObject): string build in-direct subclass list.
private	_buildInheritedSummaryHTML(doc: DocObject): string build inherited method/member summary.
private	_buildMixinClassesHTML(doc: DocObject): string build mixin extends html.
private	_buildVariationHTML(doc: DocObject): string this method is experimental. build variation of doc.

Inherited Summary

From class DocBuilder
private	_config: *
private	_data: *
public abstract	exec(callback: function) execute building output.
private	_buildCoverageHTML(coverageObj: CoverageObject): string this method was deprecated. build coverage html.
private	_buildDeprecatedHTML(doc: DocObject): string build deprecated html.
private	_buildDetailDocs(docs: DocObject[], title: string): IceCap build detail output html by docs.
private	_buildDetailHTML(doc: DocObject, kind: string, title: string, isStatic: boolean): string build detail output html by parent doc.
private	_buildDocLinkHTML(longname: string, text: string, inner: boolean, kind: string): string build html link to identifier.
private	_buildDocsLinkHTML(longnames: string[], text: string, inner: boolean, separator: string): string build html links to identifiers
private	_buildExperimentalHTML(doc: DocObject): string build experimental html.
private	_buildFileDocLinkHTML(doc: DocObject, text: string): string build html link to file page.
private	_buildLayoutDoc(): IceCap build common layout output.
private	_buildNavDoc(): IceCap build common navigation output.
private	_buildOverrideMethod(doc: DocObject): string build method of ancestor class link html.
private	_buildProperties(properties: ParsedParam[], title: string): IceCap build properties output.
private	_buildSignatureHTML(doc: DocObject): string build identifier signature html.
private	_buildSummaryDoc(docs: DocObject[], title: string, innerLink: boolean): IceCap build summary output html by docs.
private	_buildSummaryHTML(doc: DocObject, kind: string, title: string, isStatic: boolean): string build summary output html by parent doc.
private	_buildTypeDocLinkHTML(typeName: string): string build html link of type.
private	_find(cond: ...Object): DocObject[] find doc object.
private	_findAccessDocs(doc: DocObject, kind: string, isStatic: boolean): Array[] find doc object for each access.
private	_findAllIdentifiersKindGrouping(): {class: DocObject[], interface: DocObject[], function: DocObject[], variable: DocObject[], typedef: DocObject[], external: DocObject[]} find all identifiers with kind grouping.
private	_findByName(name: string, kind: string): DocObject[] fuzzy find doc object by name.
private	_getBaseUrl(fileName: string): string get base url html page.
private	_getInfo(): {title: string, version: string, url: string} get target's essential info.
private	_getOutputFileName(doc: DocObject): string get file name of output html page.
private	_getTitle(doc: DocObject): string get output html page title.
private	_getURL(doc: DocObject): string gat url of output html page.
private	_orderedFind(order: string, cond: ...Object): DocObject[] find doc objects that is ordered.
private	_readTemplate(fileName: string): string read html template.

Public Methods

public exec(callback: function(html: string, filePath: string)) source

execute building output.

Override:

DocBuilder#exec

Params:

Name	Type	Attribute	Description
callback	function(html: string, filePath: string)		is called each class.

Name

Type

Attribute

Description

callback

function(html: string, filePath: string)

is called each class.

Private Methods

private _buildClassDoc(doc: DocObject): IceCap source

build class output.

Params:

Name	Type	Attribute	Description
doc	DocObject		class doc object.

Name

Type

Attribute

Description

doc

DocObject

class doc object.

Return:

IceCap

built output.

Test:

private _buildDirectSubclassHTML(doc: DocObject): string source

build direct subclass list.

Params:

Name	Type	Attribute	Description
doc	DocObject		target class doc.

Name

Type

Attribute

Description

doc

DocObject

target class doc.

Return:

string

html of direct subclass links.

Test:

private _buildExpressionExtendsHTML(doc: DocObject): string source

build expression extends html.

Params:

Name	Type	Attribute	Description
doc	DocObject		target class doc.

Name

Type

Attribute

Description

doc

DocObject

target class doc.

Return:

string

expression extends html.

Test:

ExpressionExtends:

private _buildExtendsChainHTML(doc: DocObject): string source

build class ancestor extends chain.

Params:

Name	Type	Attribute	Description
doc	DocObject		target class doc.

Name

Type

Attribute

Description

doc

DocObject

target class doc.

Return:

string

extends chain links html.

Test:

private _buildIndirectSubclassHTML(doc: DocObject): string source

build in-direct subclass list.

Params:

Name	Type	Attribute	Description
doc	DocObject		target class doc.

Name

Type

Attribute

Description

doc

DocObject

target class doc.

Return:

string

html of in-direct subclass links.

Test:

private _buildInheritedSummaryHTML(doc: DocObject): string source

build inherited method/member summary.

Params:

Name	Type	Attribute	Description
doc	DocObject		target class doc.

Name

Type

Attribute

Description

doc

DocObject

target class doc.

Return:

string

html of inherited method/member from ancestor classes.

Test:

private _buildMixinClassesHTML(doc: DocObject): string source

build mixin extends html.

Params:

Name	Type	Attribute	Description
doc	DocObject		target class doc.

Name

Type

Attribute

Description

doc

DocObject

target class doc.

Return:

string

mixin extends html.

Test:

ExpressionExtends:

private _buildVariationHTML(doc: DocObject): string source

this method is experimental.

build variation of doc.

Params:

Name	Type	Attribute	Description
doc	DocObject		target doc object.

Name

Type

Attribute

Description

doc

DocObject

target doc object.

Return:

string

variation links html.