Class CommentsDoc

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

Source : file Docs.js at line 205

Constructor

new CommentsDoc ( )

The constructor

Source : file Docs.js at line 253

Public properties

desc : null or String

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

Source : file Docs.js at line 212

ignore : Boolean

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

Source : file Docs.js at line 247

params : null or Array of TypeDescription

The params of the commented method

Source : file Docs.js at line 233

returns : TypeDescription

The returns type of the commented method

Source : file Docs.js at line 240

sample : null or String

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

Source : file Docs.js at line 219

type : null or String

The type of the commented variable

Source : file Docs.js at line 226