ndoc icon indicating copy to clipboard operation
ndoc copied to clipboard

Multiple signatures are not correctly parsed

Open Skateside opened this issue 8 years ago • 1 comments

When a function has multiple signatures, the arguments and returns from all but the last signuature are ignored.

/**
 *  Object#one() -> Object
 *  Object#one(thing) -> String
 *  - thing (Number): A number
 *
 *  Here's the correct signature:
 *
 *      Object#one() -> Object
 *      Object#one(thing) -> String
 *      - thing (Number): A number
 *
 *  Here's how the signatures are understood:
 *
 *      Object#one
 *      Object#one(thing) -> String
 *      - thing (Number): A number
 *
 **/

You can actually see this happening on the hosted example of Prototype: http://nodeca.github.io/ndoc/tests/prototype/#Element.addMethods

Skateside avatar Dec 17 '16 16:12 Skateside

Seems to be a bug. Try to roll back to v3 or v4. Probably something was broken on rewrite.

Support of this package is very limited now. Don't expect fix soon, sorry. Also, i'd suggest to look at something jsdoc-based.

puzrin avatar Dec 17 '16 17:12 puzrin