References

Class Summary

Static Public Class Summary
public	ASTDocBuilder AST Output Builder class.
public	ASTNodeContainer
public	ASTUtil Utility for AST.
public	AbstractDoc Abstract Doc Class.
public	AssignmentDoc Doc Class for Assignment AST node.
public	ClassDoc Doc Class from Class Declaration AST node.
public	ClassDocBuilder Class Output Builder class.
public	CommentParser Doc Comment Parser class.
public	CoverageBuilder Coverage output builder class.
public	DocBuilder Builder base class.
public	DocFactory Doc factory class.
public	DocResolver Resolve various properties in doc object.
public	ESDoc API Documentation Generator.
public	ESDocCLI Command Line Interface for ESDoc.
public	ESParser ECMAScript Parser class.
public	ExternalDoc Doc Class from virtual comment node of external.
public	FileDoc Doc Class from source file.
public	FileDocBuilder File output builder class.
public	FunctionDoc Doc Class from Function declaration AST node.
public	IdentifiersDocBuilder Identifier output builder class.
public	IndexDocBuilder Index output builder class.
public	InvalidCodeLogger logger for invalid code which can not be parsed with ESDoc.
public	LintDocBuilder Lint Output Builder class.
public	ManualDocBuilder Manual Output Builder class.
public	MemberDoc Doc Class from Member Expression AST node.
public	MethodDoc Doc Class from Method Definition AST node.
public	NPMUtil Node Package Manager(npm) util class.
public	NamingUtil Identifier Naming Util class.
public	ParamParser Param Type Parser class.
public	PathResolver file path resolver.
public	Plugin Plugin system for your plugin.
public	PluginEvent Plugin Event class.
public	SearchIndexBuilder Search index of identifier builder class.
public	SingleDocBuilder Single output builder class.
public	SourceDocBuilder Source output html builder class.
public	StaticFileBuilder Static file output builder class.
public	TestDoc Doc Class from test code file.
public	TestDocBuilder Test file output html builder class.
public	TestDocFactory Test doc factory class.
public	TestFileDoc Doc class for test code file.
public	TestFileDocBuilder File output html builder class.
public	TypedefDoc Doc class for virtual comment node of typedef.
public	VariableDoc Doc Class from Variable Declaration AST node.

Function Summary

Static Public Function Summary
public	dateForUTC(date: Date): string get UTC date string.
public	markdown(text: string, breaks: boolean): string convert markdown text to html.
public	parseExample(example: string): {body: string, caption: string} parse `@example` value.
public	publish(values: DocObject[], asts: AST[], config: ESDocConfig) publish document as HTML.
public	shorten(doc: DocObject, asMarkdown: boolean): string shorten description.

Variable Summary

Static Public Variable Summary
public	aSTNodeContainer: ASTNodeContainer
public	invalidCodeLogger: InvalidCodeLogger singleton for InvalidCodeLogger
public	plugin: Plugin Instance of Plugin class.

Typedef Summary

Static Public Typedef Summary
public	AST: Object
public	ASTNode: Object
public	CoverageObject: Object
public	DocObject: Object Parsed doc comment.
public	DocTypedef: Object
public	ESDocCLIArgv: Object ESDocCLI uses argv
public	ESDocConfig: Object ESDoc config object.
public	IceCap: Object
public	IceCapInstanceTypedef: Object
public	ManualConfigItem: Object
public	NPMPackageObject: Object
public	PackageTypedef: Object
public	ParsedParam: Object
public	Taffy: Object
public	TaffyCursor: Object
public	Tag: Object doc comment tag.