Class ClassDocBuilder

Build a ClassDoc object for a class

Source : file ClassDocBuilder.js at line 36

Constructor

new ClassDocBuilder ( )

The constructor

Source : file ClassDocBuilder.js at line 63

Public methods

build ( classDeclarationNode, fileName )

Build a ClassDoc object from an ast node

Source : file ClassDocBuilder.js at line 128

Parameters

Name Type Description
classDeclarationNode Object

An ast node of type classDeclarationNode

fileName String

The file name with the path since theConfig.srcDir

Returns

The created object
Type : ClassDoc

Private properties

#commentsDocBuilder : CommentsDocBuilder

A CommentsDocBuilder object

Source : file ClassDocBuilder.js at line 57

#fileName : String

The file name ( with the path since theConfig.srcDir ) in witch the current class is declared

Source : file ClassDocBuilder.js at line 50

#rootPath : String

The path between the html file and theConfig.destDir ( something like '../../../', depending of the folders tree )

Source : file ClassDocBuilder.js at line 43

Private methods

#buildMethodOrPropertyDoc ( methodOrPropertyNode )

Build a MethodOrPropertyDoc object from an ast node

Source : file ClassDocBuilder.js at line 77

Parameters

Name Type Description
methodOrPropertyNode Object

An ast node of type ClassPrivateProperty, ClassProperty, ClassPrivateMethod or ClassMethod

Returns

The created object
Type : MethodOrPropertyDoc