Re: [Jsdoc-user] How to specify description for Constructor Summary/Detail
Status: Inactive
Brought to you by:
mmathews
From: Gabriel R. <gab...@gm...> - 2006-01-17 20:55:56
|
> 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 |