Allow optional types on tags

[parasyte]

• Some tags allow optional inclusion of a type:
• @enum : http://usejsdoc.org/tags-enum.html
• @typedef : http://usejsdoc.org/tags-typedef.html
• @param : http://usejsdoc.org/tags-param.html
• @throws : http://usejsdoc.org/tags-throws.html

Fixes exceptions when a tag is missing its optional type. E.g.:

/**
 * Testing!
 * @name test
 * @enum
 */

Raises an exception:

TypeError: Cannot read property 'substr' of undefined
    at Object.exports.parseTagTypes (.../node_modules/dox/lib/dox.js:413:38)
    at exports.parseTag (.../node_modules/dox/lib/dox.js:357:15)
    at Array.map (native)
    at Object.exports.parseComment (.../node_modules/dox/lib/dox.js:223:34)
    at Object.exports.parseComments (.../node_modules/dox/lib/dox.js:112:25)

[Twipped]

If it's not too much trouble, could you please add a test case for this?

On Sat, Apr 18, 2015 at 4:38 AM, Jay Oster notifications@github.com wrote:

• Some tags allow optional inclusion of a type:
• @enum https://github.com/enum : http://usejsdoc.org/tags-enum.html
• @typedef https://github.com/typedef :
  http://usejsdoc.org/tags-typedef.html
• @param https://github.com/param :
  http://usejsdoc.org/tags-param.html
• @throws https://github.com/throws :
  http://usejsdoc.org/tags-throws.html

Fixes exceptions when a tag is missing its optional type. E.g.:

/** * Testing! * @name test * @enum */

Raises an exception:

TypeError: Cannot read property 'substr' of undefined
at Object.exports.parseTagTypes (.../node_modules/dox/lib/dox.js:413:38)
at exports.parseTag (.../node_modules/dox/lib/dox.js:357:15)
at Array.map (native)
at Object.exports.parseComment (.../node_modules/dox/lib/dox.js:223:34)
at Object.exports.parseComments (.../node_modules/dox/lib/dox.js:112:25)

---

You can view, comment on, or merge this pull request online at:

#166
Commit Summary

• Allow optional types on tags

File Changes

• M lib/dox.js https://github.com/tj/dox/pull/166/files#diff-0 (3)

Patch Links:

• https://github.com/tj/dox/pull/166.patch
• https://github.com/tj/dox/pull/166.diff

—
Reply to this email directly or view it on GitHub
#166.

[parasyte]

For sure! Will do in a bit.

Looks like this was fixed once and regressed: #137

[parasyte]

@ChiperSoft I added a simple test for this one.

[parasyte]

Discovered a few other edge cases while writing more tests. I'm happy with it now.

[Twipped]

Awesome, thank you very much.