src/doc.jsx

class DocCommentNode

new DocCommentNode()

function getDescription() : string

function appendDescription(s : string) : void

class DocCommentParameter extends DocCommentNode

new DocCommentParameter(token : Token)

function getToken() : Token

function getParamName() : string

override function getDescription() : string

class DocCommentTag extends DocCommentNode

new DocCommentTag(tagName : string)

function getTagName() : string

class DocComment extends DocCommentNode

new DocComment()

function getParams() : Array.<DocCommentParameter>

function getTags() : Array.<DocCommentTag>

function getTagByName(tagName : string) : DocCommentTag

function getTagsByName(tagName : string) : Array.<DocCommentTag>

class DocumentGenerator

new DocumentGenerator(compiler : Compiler, templatePath : string, outputPath : string)

compiler Compiler instance
templatePath a directory which has document resources (template.html and style.css)
outputPath the output directory

function setResourceFiles(files : Array.<string>) : DocumentGenerator

function setPathFilter(pathFilter : function (:string) : boolean) : DocumentGenerator

function buildDoc() : void