bug: @returns does not respect jsdocUseColumns false

[shunkica]

Here is the related fixture:

module.exports = {
  only: true,
  jsdocPrintWidth: 95,
  jsdocUseColumns: false,
};

//# input

/**
 * @param {foo} bar baz
 * @returns {number} Returns how the node is positioned relatively to the reference node
 * according to the bitmask. 0 if reference node and given node are the same.
 */

//# output

/**
 * @param {foo} bar
 * Baz.
 * @returns {number}
 * Returns how the node is positioned relatively to the reference node according to the
 * bitmask. 0 if reference node and given node are the same.
 */

The actual output is:

/**
 * @param {foo} bar
 * Baz.
 * @returns {number} Returns how the node is positioned relatively to the reference node
 *                   according to the bitmask. 0 if reference node and given node are the same.
 */

[shunkica]

The problem seems to be that the description of @returns gets placed in the name property instead of the description property, but @returns shouldn't have a name property.

[shunkica]

The issue seems to originate from comment-parser

It is already reported here
There is a possible workaround mentioned, and no plan to fix this behavior has been announced.

[homer0]

@shunkica thanks for tracking it down :D. @returns is not the only tag with that issue, and I already have workarounds in place for cases with no description, no name, or description split between name and description.

For some reason, it seems like I intentionally wanted the description of the @returns to match the description of the @params, on column mode, so I had it on the wrong group.

Since, I believe, you are still using v6, a workaround to get this fix would be to follow these instructions to extend the plugin, and override getTagsWithDescriptionAsName && getTagsWithNameAsDescription to match the changes in this commit.

[shunkica]

Thanks for the response. We have moved to v7 since so it should be good once you release a fix.

[github-actions]

🎉 This issue has been resolved in version 7.0.3 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀