Multi-line name/description parsing

[brettz9]

For the following:

     /**
       * @param {{includeWhiteSpace: (boolean|undefined),
       *    ignoreElementOrder: (boolean|undefined)}} [options] The options.
       */

...the tag source gives the following:

[
  {
    number: 1,
    source: '       * @param {{includeWhiteSpace: (boolean|undefined),',
    tokens: {
      start: '       ',
      delimiter: '*',
      postDelimiter: ' ',
      tag: '@param',
      postTag: ' ',
      name: '',
      postName: '',
      type: '{{includeWhiteSpace: (boolean|undefined),',
      postType: '',
      description: '',
      end: ''
    }
  },
  {
    number: 2,
    source: '       *    ignoreElementOrder: (boolean|undefined)}} [options] The options.',
    tokens: {
      start: '       ',
      delimiter: '*',
      postDelimiter: ' ',
      tag: '',
      postTag: '',
      name: '',
      postName: '',
      type: '   ignoreElementOrder: (boolean|undefined)}}',
      postType: '',
      description: 'ptions] The options.',
      end: ''
    }
  },
  {
    number: 3,
    source: '       */',
    tokens: {
      start: '       ',
      delimiter: '',
      postDelimiter: '',
      tag: '',
      postTag: '',
      name: '',
      postName: '',
      type: '',
      postType: '',
      description: '',
      end: '*/'
    }
  }
]

Note how options is not picked up as a name and as a description, it is cut off as well.

[syavorsky]

I will investigate this [UPD: stripped email response artifacts]

[simonseyock]

I just got the hint from @tschaub that this issue seems very similar to an issue of the jsdoc parser in typescript. The issue was related to the nested types. It might be a little easier maybe as the comment-parser lib does not parse types on itself if I am not mistaken. The issue is microsoft/TypeScript#26528 and has quite complex tests that might be interesting.

[syavorsky]

fixed in comment-parser@1.1.2

[brettz9]

Looks to be working nicely, so will close, thanks so much!

[syavorsky]

Great. Thanks for reporting this