@description seems to be ignored ?

[bojand]

Looking at #9 it says @description tag is supported. I can't seem to get it to show up using either ~3.0.0 or ~4.0.0-beta and the default template.

Sample code:

/**
 * Returns number x 2
 *
 * @description Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut
 * labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
 * aliquip ex ea commodo consequat.
 *
 * @param {number} num - number to double
 * @returns {number} the number doubled
 */
module.exports = function(num) {
  return num * 2;
}

Should this work? Basically I would like to have a shorter description (ie @summary which doesn't seem to be supported yet?) and then once the documentation section expanded, the greater detail (@description). @desc also gets ignored.

Thanks

[tmcw]

You're right - the default description is supported, but not the tagged kind. Unchecking that box to mark it as still to-do.

[jfirebaugh]

Core support for @description and @summary added in 3e4a7cb. Still need to add them to the default theme.

[tmcw]

The implementation in 3e4a7cb was all we needed for @description support! The behavior of a tagged description is that it can be anywhere in a comment, instead of just at the beginning of the comment. If both are provided, the tagged description overrides the freeform one, as I'm making clear in the usejsdoc documentation. I'm going to improve test coverage here to lock this in.

[Berkmann18]

@summary seems to be ignored regardless of its position compared to @description within the same doclet. I tried having both with the @description tag removed like so:

/**
 * Default output destination.
 * @summary stdout
 * @constant
 * @type {string}
 */
const OUTPUT_DEST = 'stdout';

/**
 * @summary text  
 * Default output format.
 * @constant
 * @type {string}
 */
const OUTPUT_FORMAT = 'text';

But OUTPUT_DEST has its description being shown (same if I used @description) but OUTPUT_FORMAT has neither the summary nor the description.

I'm aware that the @summary tag isn't fully supported for both Markdown and HTML (I use both but find this would experimenting on the HTML one) but #9 pointed to this issue which was closed.