-
Notifications
You must be signed in to change notification settings - Fork 0
Description
@constructor
is hidden here:
https://github.com/bitovi/documentjs/blob/master/lib/tags/constructor.js#L9
https://github.com/bit-docs/bit-docs-js/blob/master/tags/constructor.js#L9
Because it is deprecated in favor of @function
(a constructor is a function).
@class
does this => console.warn("Using the @class directive. It is deprecated!");
:
https://github.com/bit-docs/bit-docs-js/blob/master/tags/class.js#L17
Should we do something similar to console.warn
for @constructor
, then?
Note that JSDoc (what bit-docs
is based on) talks about using @constructor
:
http://usejsdoc.org/about-getting-started.html#adding-documentation-comments-to-your-code
I'm not sure if there's any functional difference between @function
and @constructor
, or if it's just more explicit terminology. I think fewer tags are better, especially if they duplicate functionality.