summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/node_modules/eslint-plugin-jsdoc/dist/defaultTagOrder.js
blob: 86bb5dbfc0e919e08089e4f72ea364d2d75d5046 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.default = void 0;
const defaultTagOrder = [
// Brief descriptions
'summary', 'typeSummary',
// Module/file-level
'module', 'exports', 'file', 'fileoverview', 'overview',
// Identifying (name, type)
'typedef', 'interface', 'record', 'template', 'name', 'kind', 'type', 'alias', 'external', 'host', 'callback', 'func', 'function', 'method', 'class', 'constructor',
// Relationships
'modifies', 'mixes', 'mixin', 'mixinClass', 'mixinFunction', 'namespace', 'borrows', 'constructs', 'lends', 'implements', 'requires',
// Long descriptions
'desc', 'description', 'classdesc', 'tutorial', 'copyright', 'license',
// Simple annotations

// TypeScript
'internal', 'const', 'constant', 'final', 'global', 'readonly', 'abstract', 'virtual', 'var', 'member', 'memberof', 'memberof!', 'inner', 'instance', 'inheritdoc', 'inheritDoc', 'override', 'hideconstructor',
// Core function/object info
'param', 'arg', 'argument', 'prop', 'property', 'return', 'returns',
// Important behavior details
'async', 'generator', 'default', 'defaultvalue', 'enum', 'augments', 'extends', 'throws', 'exception', 'yield', 'yields', 'event', 'fires', 'emits', 'listens', 'this',
// Access
'static', 'private', 'protected', 'public', 'access', 'package', '-other',
// Supplementary descriptions
'see', 'example',
// METADATA

// Other Closure (undocumented) metadata
'closurePrimitive', 'customElement', 'expose', 'hidden', 'idGenerator', 'meaning', 'ngInject', 'owner', 'wizaction',
// Other Closure (documented) metadata
'define', 'dict', 'export', 'externs', 'implicitCast', 'noalias', 'nocollapse', 'nocompile', 'noinline', 'nosideeffects', 'polymer', 'polymerBehavior', 'preserve', 'struct', 'suppress', 'unrestricted',
// @homer0/prettier-plugin-jsdoc metadata
'category',
// Non-Closure metadata
'ignore', 'author', 'version', 'variation', 'since', 'deprecated', 'todo'];
var _default = defaultTagOrder;
exports.default = _default;
module.exports = exports.default;
//# sourceMappingURL=defaultTagOrder.js.map