• constructor

@description DocumentJS.tags.description

 

Provide a short description.

@description CONTENT

/**
 * @signature `new lib.Component(name)`
 * @description A component for the lib library.
 */
lib.Component = function(name){}

The text following @description is added at the top of the documentation page. By default any text in a comment that isn't after a multi-line @ directive is added to the description of the DocObject. @description can be used to escape a multi-line @ directive.