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

public class | source

ManualDocBuilder

Extends:

DocBuilder → ManualDocBuilder

Manual Output Builder class.

Test:

Manual:

Method Summary

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

Private Methods
private	_buildManual(item: ManualConfigItem): IceCap build manual.
private	_buildManualIndex(manualConfig: ManualConfigItem[]): IceCap built manual index.
private	_buildManualNav(manualConfig: ManualConfigItem[]): IceCap build manual navigation.
private	_convertMDToHTML(item: ManualConfigItem): string convert markdown to html.
private	_getLabelSynonyms(label: string): string[] get label synonyms.
private	_getManualConfig(): ManualConfigItem[] get manual config based on `config.manual`.
private	_getManualOutputFileName(item: ManualConfigItem): string get manual file name.

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), callbackForCopy: function(src: string, dest: string)) source

execute building output.

Override:

DocBuilder#exec

Params:

Name	Type	Attribute	Description
callback	function(html: string, filePath: string)		is called each manual.
callbackForCopy	function(src: string, dest: string)		is called asset.

Name

Type

Attribute

Description

callback

function(html: string, filePath: string)

is called each manual.

callbackForCopy

function(src: string, dest: string)

is called asset.

Private Methods

private _buildManual(item: ManualConfigItem): IceCap source

build manual.

Params:

Name	Type	Attribute	Description
item	ManualConfigItem		target manual config item.

Name

Type

Attribute

Description

item

ManualConfigItem

target manual config item.

Return:

IceCap

built manual.

private _buildManualIndex(manualConfig: ManualConfigItem[]): IceCap source

built manual index.

Params:

Name	Type	Attribute	Description
manualConfig	ManualConfigItem[]		target manual config.

Name

Type

Attribute

Description

manualConfig

ManualConfigItem[]

target manual config.

Return:

IceCap

built index.

Test:

private _buildManualNav(manualConfig: ManualConfigItem[]): IceCap source

build manual navigation.

Params:

Name	Type	Attribute	Description
manualConfig	ManualConfigItem[]		target manual config.

Name

Type

Attribute

Description

manualConfig

ManualConfigItem[]

target manual config.

Return:

IceCap

built navigation

Test:

private _convertMDToHTML(item: ManualConfigItem): string source

convert markdown to html. if markdown has only one h1 and it's text is item.label, remove the h1. because duplication h1 in output html.

Params:

Name	Type	Attribute	Description
item	ManualConfigItem		target.

Name

Type

Attribute

Description

item

ManualConfigItem

target.

Return:

string

converted html.

private _getLabelSynonyms(label: string): string[] source

get label synonyms.

Params:

Name	Type	Attribute	Description
label	string		target item label.

Name

Type

Attribute

Description

label

string

target item label.

Return:

string[]

synonyms

private _getManualConfig(): ManualConfigItem[] source

get manual config based on config.manual.

Return:

ManualConfigItem[]

built manual config.

private _getManualOutputFileName(item: ManualConfigItem): string source

get manual file name.

Params:

Name	Type	Attribute	Description
item	ManualConfigItem		target manual config item.

Name

Type

Attribute

Description

item

ManualConfigItem

target manual config item.

Return:

string

file name.