Tag Support Master Ticket

[tmcw]

✔︎: full support ➖: partial support ✘: no support

Complete

Tag	Core	Markdown	HTML	Issues
@alias	✔︎	✔︎	✔︎
@async	➖	➖	➖
@augments	✔︎	✔︎	✔︎
@deprecated	✔︎︎	✔︎︎︎︎	✔︎︎︎︎
@description	✔︎︎	✔︎	✔︎
@copyright	✔︎︎	✔︎	✔︎
@example	✔︎︎︎︎	✔︎︎︎︎	✔︎︎︎︎
@author	✔︎	✔︎	✔︎
@function	✔︎︎︎︎	✔︎	✔︎
@global	✔︎︎︎︎	✔︎	✔︎
@ignore	✔︎︎︎︎	✔︎	✔︎
@instance	✔︎︎︎︎	✔︎	✔︎
@lends	✔︎︎︎︎	✔︎︎	✔︎︎	lends is an inference hint
@license	✔︎︎︎︎	✔︎	✔︎
@name	✔︎︎︎︎	✔︎	✔︎
@param	✔︎︎︎︎	✔︎	✔︎
@throws	✔︎︎︎︎	✔︎	✔︎
@member	✔︎︎︎︎	✔︎	✔︎
@version	✔︎	✔︎	✔︎
@returns	✔︎︎︎︎	✔︎	✔︎
@since	✔︎	✔︎	✔︎
@static	✔︎︎︎︎	✔︎	✔︎
@property	✔︎︎︎︎	✔︎	✔︎

Unfinished

Tag	Core	Markdown	HTML	Issues
@abstract	✔︎	✘	✘
@access	✔︎	➖	➖
@borrows	✘︎	✘	✘
@inner	✔︎︎︎︎	✔︎	✔︎
@callback	✔︎︎	✘	✘
@class	✔︎︎	✘	✘
@classdesc	✔︎︎	✘	✘	#109
@constant	✔︎︎	✘	✘
@constructs	✘︎︎	✘	✘
@default	✘︎︎	✘	✘
@enum	✘︎︎	✘	✘
@event	➖	✘	✘	#96
@exports	✘︎︎	✘	✘
@external	✔︎︎︎︎	✘	✘
@file	✔︎︎︎︎	✘	✘
@fires	✘︎︎︎︎	✘	✘
@implements	✘︎︎︎︎	✘	✘
@inheritdoc	✘︎︎︎︎	✘	✘
@interface	✔︎︎︎︎	✘	✘
@kind	✔︎︎︎︎	✘	✘
@listens	✘︎︎︎︎	✘	✘
@memberof	➖	✔︎	✔︎	#189
@mixes	✘︎︎︎︎	✘	✘
@mixin	✔︎︎︎︎	✘	✘
@module	✔︎︎︎︎	✘	✘
@namespace	✔︎︎︎︎	✘	✘
@override	✔︎︎︎︎	✘	✘
@private	✔︎	➖	➖
@protected	✔︎	➖	➖
@public	✔︎	➖	➖
@readonly	✔︎	✘	✘
@requires	✘︎︎︎︎	✘	✘
@see	✔︎	✘	✘
@summary	✔︎	✘	✘	#341
@this	✘︎︎︎︎	✘	✘
@todo	✔︎	✘	✘
@tutorial	✘︎︎︎︎	✘	✘
@type	✔︎	✘	✘
@typedef	✔︎	✘	✘	#372
@variation	✔︎	✘	✘

[montogeek]

Hi!

Is there any update on this? :)

[lucaswoj]

Noting that the HTML and Markdown columns above refer to whether or not the tag's value is rendered in the provided default HTML / Markdown theme.

[dignifiedquire]

I need enum support for my projects, what exactly is missing there to support it?

[tmcw]

The first place is parse.js, which currently has a todo for enum. And then implementing output and any effect on hierarchy (I don't think enum affects hierarchy).

Unfortunately the more I read usejsdoc.org the less it makes sense:

A numeric enum with a... boolean?

[tmcw]

✔️ Merged @deprecated tag support

[AndyOGo]

Awesome tool. ~~But I can't use @module in combination with @memberOf to generate grouped markdown docs:(~~

Already tracked here #234