docschema
Version:
Schema declaration and validation library using JsDoc comments
35 lines (34 loc) • 805 B
JavaScript
/**
* List of From => To values
*
* IMPORTANT: For the keys, put keys like @constructor
* before @const, so the tag replacements works properly
* after that.
*
* @see https://jsdoc.app/
* @readonly
* @enum {string}
*/
export const TAG_REPLACEMENTS = Object.freeze({
'@virtual': '@abstract',
'@extends': '@augments',
'@constructor': '@class',
'@const': '@constant',
'@defaultvalue': '@default',
'@desc': '@description',
'@host': '@external',
'@fileoverview': '@file',
'@overview': '@file',
'@emits': '@fires',
'@func': '@function',
'@method': '@function',
'@var': '@member',
'@arg': '@param',
'@argument': '@param',
'@prop': '@property',
'@return': '@returns',
'@exception': '@throws',
'@yield': '@yields',
'@linkcode': '@link',
'@linkplain': '@link'
})