typedoc
Version:
Create api documentation for TypeScript projects.
86 lines (85 loc) • 1.61 kB
JavaScript
// If updating these lists, also update tsdoc.json
export const tsdocBlockTags = [
"@defaultValue",
"@deprecated",
"@example",
"@param",
"@privateRemarks",
"@remarks",
"@returns",
"@see",
"@throws",
"@typeParam",
];
export const blockTags = [
...tsdocBlockTags,
"@author",
"@callback",
"@category",
"@categoryDescription",
"@default",
"@document",
"@extends",
"@augments", //Alias for @extends
"@yields",
"@group",
"@groupDescription",
"@import",
"@inheritDoc",
"@jsx",
"@license",
"@module",
"@mergeModuleWith",
"@prop",
"@property",
"@return",
"@satisfies",
"@since",
"@template", // Alias for @typeParam
"@type",
"@typedef",
"@summary",
];
export const tsdocInlineTags = ["@link", "@inheritDoc", "@label"];
export const inlineTags = [
...tsdocInlineTags,
"@linkcode",
"@linkplain",
"@include",
"@includeCode",
];
export const tsdocModifierTags = [
"@alpha",
"@beta",
"@eventProperty",
"@experimental",
"@internal",
"@override",
"@packageDocumentation",
"@public",
"@readonly",
"@sealed",
"@virtual",
];
export const modifierTags = [
...tsdocModifierTags,
"@abstract",
"@class",
"@enum",
"@event",
"@expand",
"@hidden",
"@hideCategories",
"@hideconstructor",
"@hideGroups",
"@ignore",
"@inline",
"@interface",
"@namespace",
"@overload",
"@private",
"@protected",
"@showCategories",
"@showGroups",
"@useDeclaredType",
];