search

sonypiay / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

summary and @description, except for @class #312

Open GoogleCodeExporter opened 8 years ago

GoogleCodeExporter commented 8 years ago 
Hey,

I'm using document blocks like this:

/**
 * Summary of my Method
 *
 * @description
 * A longer description what my method does goes here....
 */

This is great. I don't know if this is intentional but it works really good. 
The text "Summary of my Method" is displayed in the summary table and the text 
"A longer description what my method does goes here...." is displayed in the 
details. Unfortunately this is not the case for classes through @class. I 
actually expected the summary of my class to appear in the class index 
(referreing the output of the jsdoc template) and the longer description to 
appear on the class detail page (see issue #310 for more info on this).

I know there is I guess a json model behind before it get's onto the template, 
but I can't judge this for now (possibly it's in there) and can only rate on 
the visual html output.

Would love to see this implemented.
Thanks.

Original issue reported on code.google.com by unigossi on 27 Dec 2010 at 8:15