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

public class | source

SourceDocBuilder

Extends:

DocBuilder → SourceDocBuilder

Source output html builder class.

Constructor Summary

Public Constructor
public	constructor(data: Taffy, config: ESDocConfig, coverage: CoverageObject) create instance.

Member Summary

Private Members
private	_coverage: *

Method Summary

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

Private Methods
private	_buildSourceHTML(): string build source list output html.

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 Constructors

public constructor(data: Taffy, config: ESDocConfig, coverage: CoverageObject) source

create instance.

Override:

DocBuilder#constructor

Params:

Name	Type	Attribute	Description
data	Taffy		doc object database.
config	ESDocConfig		use config to build output.
coverage	CoverageObject		use coverage to build output.

Private Members

private _coverage: * source

Public Methods

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

execute building output html.

Override:

DocBuilder#exec

Params:

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

Name

Type

Attribute

Description

callback

function(html: string, filePath: string)

is called with output html.

Private Methods

private _buildSourceHTML(): string source

build source list output html.

Return:

string

html of source list.