jsdoc-user

[Jsdoc-user] How to specify description for Constructor Summary/Detail

[Adam R. <ad...@pr...>]

Hi Gabriel

Is there a way to specify the description for the class constructor  
summary and/or detail?

Cheers
Adam

Re: [Jsdoc-user] How to specify description for Constructor Summary/Detail

[Gabriel R. <gab...@gm...>]

 
> Is there a way to specify the description for the class constructor  
> summary and/or detail?
> 

The starting documentation in the documentation block for a constructor
function will be used as the summary/detail for that constructor. For
example:

/**
 * This is the class constructor summary. This second sentence will only
 * appear in the constructor detail.
 * @class This is the optional class information.
 */
function MyClassConstructor(){
}


Hope this is what you were looking for.

- Gabriel