search

bitovi / documentjs

The sophisticated documentation engine
https://documentjs.com/
MIT License
598 stars 381 forks source link

All JSDocs tags that are supported by documentjs aren't documented #241

Open gdad-s-river opened 8 years ago

gdad-s-river commented 8 years ago

for example constructor (is in jsdoc, so it's okay...), codestart tags are parsed by documentjs but isn't documented. At the same time extends (although there is inherit tag for it), version tags, for example, aren't understood by documentjs, but it isn't called out anywhere. I'm calling this out because the github readme of documentjs repo says

Specify your code's behavior precisely with JSDoc and Google Closure Compiler annotations.

justinbmeyer commented 8 years ago

Most of those tags are legacy (codestart, extends). Constructor is also legacy, but after Class was added to JavaScript, we've thought about brining @class or @constructor back.