Skip to content

[tsdoc] remove "const" keyword before enum to use with typescript isolatedModules #306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions common/changes/@microsoft/tsdoc/master_2021-12-07-00-40.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"changes": [
{
"packageName": "@microsoft/tsdoc",
"comment": "remove \"const\" keyword before enums to allow use with typescript isolatedModules",
"type": "patch"
}
],
"packageName": "@microsoft/tsdoc",
"email": "[email protected]"
}
10 changes: 5 additions & 5 deletions tsdoc/etc/tsdoc.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ export abstract class DocNodeContainer extends DocNode {
}

// @public
export const enum DocNodeKind {
export enum DocNodeKind {
// (undocumented)
Block = "Block",
// (undocumented)
Expand Down Expand Up @@ -440,7 +440,7 @@ export enum EscapeStyle {
}

// @public
export const enum ExcerptKind {
export enum ExcerptKind {
// (undocumented)
BlockTag = "BlockTag",
// (undocumented)
Expand Down Expand Up @@ -1095,15 +1095,15 @@ export class PlainTextEmitter {
}

// @public
export const enum SelectorKind {
export enum SelectorKind {
Error = "error",
Index = "index",
Label = "label",
System = "system"
}

// @public
export const enum Standardization {
export enum Standardization {
Core = "Core",
Discretionary = "Discretionary",
Extended = "Extended",
Expand Down Expand Up @@ -1269,7 +1269,7 @@ export class TSDocEmitter {
}

// @public
export const enum TSDocMessageId {
export enum TSDocMessageId {
AtSignInWord = "tsdoc-at-sign-in-word",
AtSignWithoutTagName = "tsdoc-at-sign-without-tag-name",
CharactersAfterBlockTag = "tsdoc-characters-after-block-tag",
Expand Down
2 changes: 1 addition & 1 deletion tsdoc/src/details/Standardization.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Used to group the {@link StandardTags} definitions according to the level of support
* expected from documentation tools that implement the standard.
*/
export const enum Standardization {
export enum Standardization {
/**
* TSDoc tags in the "Core" standardization group are considered essential.
* Their meaning is standardized, and every documentation tool is expected
Expand Down
2 changes: 1 addition & 1 deletion tsdoc/src/nodes/DocExcerpt.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { TokenKind } from '../parser/Token';
/**
* Indicates the type of {@link DocExcerpt}.
*/
export const enum ExcerptKind {
export enum ExcerptKind {
Spacing = 'Spacing',

BlockTag = 'BlockTag',
Expand Down
2 changes: 1 addition & 1 deletion tsdoc/src/nodes/DocMemberSelector.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { DocExcerpt, ExcerptKind } from './DocExcerpt';
/**
* Kinds of TSDoc selectors.
*/
export const enum SelectorKind {
export enum SelectorKind {
/**
* Used in cases where the parser encounters a string that is incorrect but
* valid enough that a DocMemberSelector node was created.
Expand Down
2 changes: 1 addition & 1 deletion tsdoc/src/nodes/DocNode.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { TSDocConfiguration } from '../configuration/TSDocConfiguration';
* To avoid naming conflicts between projects, the enum value should be a string comprised of your full
* NPM package name, followed by a "#" symbol, followed by the class name (without the "Doc" prefix).
*/
export const enum DocNodeKind {
export enum DocNodeKind {
Block = 'Block',
BlockTag = 'BlockTag',
Excerpt = 'Excerpt',
Expand Down
2 changes: 1 addition & 1 deletion tsdoc/src/parser/TSDocMessageId.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
*
* @public
*/
export const enum TSDocMessageId {
export enum TSDocMessageId {
/**
* File not found
* @remarks
Expand Down