Special case for return tag

[maxless]

/**
 * This is an example function 2.
 * You may use it as you like.
 * @param {number} arg1 First argument.
 * @param {number} arg2 Second argument.
 * @return {number} Error code.
**/

is currently parsed into the following tags:

[
...,
  {
    tag: 'param',
    name: 'arg2',
    type: 'number',
    optional: false,
    description: 'Second argument.',
    problems: [],
    source: [ [Object] ]
  },
  {
    tag: 'return',
    name: 'Error',
    type: 'number',
    optional: false,
    description: 'code.',
    problems: [],
    source: [ [Object], [Object] ]
  }
]

Is there a simple way to make the return tag behave properly with description resulting in "Error code"? This is a part of JSDoc spec: https://jsdoc.app/tags-returns.html

[brettz9]

comment-parser is agnostic to the syntax, so you have to use tokenizers. You can see how we provide a JSDoc-specific usage of this at https://github.com/es-joy/jsdoccomment/blob/08b258d7ede45abf58d354683faf1a7391dcf409/src/parseComment.js#L116 .