Class CommentsDoc

A class with properties found in the comments and needed to build the html files for classes/methods/properties/variables

Source : file CommentsDoc.js at line 33

Constructor

new CommentsDoc ( )

The constructor

Source : file CommentsDoc.js at line 81

Public properties

desc : null or String

The description of the commented class/method/property/variable

Source : file CommentsDoc.js at line 40

ignore : Boolean

A flag indicating that the class/method/property/variable have to be ignored

Source : file CommentsDoc.js at line 75

params : null or Array of TypeDescription

The params of the commented method

Source : file CommentsDoc.js at line 61

returns : TypeDescription

The returns type of the commented method

Source : file CommentsDoc.js at line 68

sample : null or String

The sample of the commented class/method/property/variable

Source : file CommentsDoc.js at line 47

type : null or String

The type of the commented variable

Source : file CommentsDoc.js at line 54