From c6854468180f3249b8312973fd7e8d420be0a773 Mon Sep 17 00:00:00 2001 From: Brandon Chan Date: Tue, 7 Jul 2026 16:17:12 -0700 Subject: [PATCH 1/4] Markup changes and update tests --- .../additiveBetaChange.spec.ts.snap | 4 +- .../arrayOfOptionalVariants.spec.ts.snap | 2 +- .../arrayOfVariants.spec.ts.snap | 2 +- .../bounds/__snapshots__/bounds.spec.ts.snap | 40 ++--- .../changelogDiffing.spec.ts.snap | 142 +++++++++--------- .../__snapshots__/closures.spec.ts.snap | 11 +- .../__snapshots__/data_buffer.spec.ts.snap | 20 +-- .../deprecationWarning.spec.ts.snap | 32 ++-- .../errors/__snapshots__/errors.spec.ts.snap | 28 ++-- .../__snapshots__/escapedNames.spec.ts.snap | 10 +- .../__snapshots__/general.spec.ts.snap | 30 ++-- .../hybrid_script_native_module.spec.ts.snap | 32 ++-- .../__snapshots__/iterator.spec.ts.snap | 4 +- .../test/maps/__snapshots__/maps.spec.ts.snap | 6 +- .../__snapshots__/optionals.spec.ts.snap | 10 +- .../prereleaseWarning.spec.ts.snap | 6 +- .../propertyAndFunctionPrivilege.spec.ts.snap | 94 ++++++------ .../recordOfOptionalVariants.spec.ts.snap | 2 +- .../script_generated_module.spec.ts.snap | 4 +- .../__snapshots__/skipMerging.test.ts.snap | 4 +- .../__snapshots__/skipMerging.test.ts.snap | 2 +- .../staticFunctions.spec.ts.snap | 8 +- .../__snapshots__/typeLinking.spec.ts.snap | 48 +++--- .../__snapshots__/variants.spec.ts.snap | 8 +- .../templates/tsdef/function.mustache | 7 +- .../templates/tsdef/property.mustache | 13 +- 26 files changed, 290 insertions(+), 279 deletions(-) diff --git a/tools/api-docs-generator-test-snapshots/test/additive_beta_change/__snapshots__/additiveBetaChange.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/additive_beta_change/__snapshots__/additiveBetaChange.spec.ts.snap index 5425d347..a21c0122 100644 --- a/tools/api-docs-generator-test-snapshots/test/additive_beta_change/__snapshots__/additiveBetaChange.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/additive_beta_change/__snapshots__/additiveBetaChange.spec.ts.snap @@ -187,7 +187,7 @@ export class ExampleClass1 { private constructor(); /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testMethodWithAddedArgument(): boolean; @@ -226,7 +226,7 @@ export class ExampleClass1 { private constructor(); /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testMethodWithAddedArgument(addedArg?: number): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/array_of_optional_variants/__snapshots__/arrayOfOptionalVariants.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/array_of_optional_variants/__snapshots__/arrayOfOptionalVariants.spec.ts.snap index f72b488a..dde06029 100644 --- a/tools/api-docs-generator-test-snapshots/test/array_of_optional_variants/__snapshots__/arrayOfOptionalVariants.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/array_of_optional_variants/__snapshots__/arrayOfOptionalVariants.spec.ts.snap @@ -90,7 +90,7 @@ export class ClassWithArrayOfVariantsProperty { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ exampleMember?: (boolean | number | string | undefined)[]; diff --git a/tools/api-docs-generator-test-snapshots/test/array_of_variants/__snapshots__/arrayOfVariants.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/array_of_variants/__snapshots__/arrayOfVariants.spec.ts.snap index 9d22952e..1a163930 100644 --- a/tools/api-docs-generator-test-snapshots/test/array_of_variants/__snapshots__/arrayOfVariants.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/array_of_variants/__snapshots__/arrayOfVariants.spec.ts.snap @@ -90,7 +90,7 @@ export class ClassWithArrayOfVariantsProperty { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ exampleMember?: (boolean | string)[]; diff --git a/tools/api-docs-generator-test-snapshots/test/bounds/__snapshots__/bounds.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/bounds/__snapshots__/bounds.spec.ts.snap index d140de0c..e5275925 100644 --- a/tools/api-docs-generator-test-snapshots/test/bounds/__snapshots__/bounds.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/bounds/__snapshots__/bounds.spec.ts.snap @@ -479,68 +479,68 @@ export class ClassWithBounds { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * Bounds: [0, 0] */ r: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * Minimum Value: -255 */ s: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * Maximum Value: 1 */ t: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ u: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * Bounds: [-255, -1] */ v: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ w: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * Minimum Value: 1 */ x: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * Maximum Value: 255 */ y: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * Bounds: [1, 255] */ z: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @param s * Minimum value: -255 @@ -602,68 +602,68 @@ export class ClassWithBounds { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * Bounds: [0, 0] */ r: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * Minimum Value: 1 */ s: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * Maximum Value: 255 */ t: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ u: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * Bounds: [1, 255] */ v: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * Bounds: [1, 255] */ w: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * Maximum Value: 255 */ x: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * Minimum Value: 1 */ y: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ z: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @param s * Minimum value: 1 diff --git a/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap index bd866cb1..1d880404 100644 --- a/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap @@ -4079,7 +4079,7 @@ export class ClassWithCrossModuleProperty { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ exampleProperty: testmodule1.SmallClass; @@ -4117,7 +4117,7 @@ export class ClassWithCrossModuleProperty { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ exampleProperty: testmodule1.SmallClass; @@ -4155,7 +4155,7 @@ export class ClassWithCrossModuleProperty { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ exampleProperty: testmodule1.SmallClass; @@ -4250,25 +4250,25 @@ export class ClassWithAddedBaseClass { export class ClassWithConstructor { /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ x: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ y: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ z: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ constructor(x: number, y: number, z: number); @@ -4283,13 +4283,13 @@ export class EntityIterator implements Iterable { private constructor(); /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ [Symbol.iterator](): Iterator; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ next(): IteratorResult; @@ -4299,43 +4299,43 @@ export class ExampleClass1 { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ boolProperty: boolean; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ floatProperty: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ int16Property: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ int32Property: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ int64Property: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ int8Property: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4343,13 +4343,13 @@ export class ExampleClass1 { readonly propertyWithReadOnlyChanging: string; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ stringProperty: string; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4357,68 +4357,68 @@ export class ExampleClass1 { readonly stringPropertyReadOnly: string; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ uint16Property: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ uint32Property: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ uint64Property: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ uint8Property: number; static readonly ClassConstantExample = 1337; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testMethod(stringArgument: string, stringArgumentOptional?: string): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testMethodWithAddedArgument(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testMethodWithAddedErrorable(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testMethodWithChangedArgumentType(arg: string): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testMethodWithChangedReturnType(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testMethodWithRemovedArgument(removedArg: string): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ @@ -4429,7 +4429,7 @@ export class SmallClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4452,31 +4452,31 @@ export interface RemovedInterface { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function testFunctionWithAddedArgument(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function testFunctionWithAddedErrorable(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function testFunctionWithChangedArgumentType(arg: string): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function testFunctionWithRemovedArgument(removedArg: string): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ @@ -4554,37 +4554,37 @@ export class ClassWithAddedBaseClass extends SmallClass { export class ClassWithConstructor { /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ w: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ x: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ y: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ z: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ constructor(x: number, y: number, z: number); /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testFunction(argument1: string, argument2: string): number; @@ -4598,13 +4598,13 @@ export class EntityIterator implements Iterable { private constructor(); /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ [Symbol.iterator](): Iterator; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ next(): IteratorResult; @@ -4614,62 +4614,62 @@ export class ExampleClass1 { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ boolProperty: boolean; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ floatProperty: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ int16Property: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ int32Property: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ int64Property: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ int8Property: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ propertyWithChangedType: boolean; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ propertyWithReadOnlyChanging: string; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ stringProperty: string; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4677,69 +4677,69 @@ export class ExampleClass1 { readonly stringPropertyReadOnly: string; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ uint16Property: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ uint32Property: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ uint64Property: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ uint8Property: number; static readonly ClassConstantExample = 1338; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testMethod(stringArgument: string, stringArgumentOptional?: string): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testMethodWithAddedArgument(addedArg: string): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ testMethodWithAddedErrorable(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testMethodWithChangedArgumentType(arg: number): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testMethodWithChangedReturnType(): string; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testMethodWithRemovedArgument(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ testMethodWithRemovedErrorable(): boolean; @@ -4749,7 +4749,7 @@ export class SmallClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4766,38 +4766,38 @@ export interface ExampleInterface { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function testFunctionWithAddedArgument(addedArg: string): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ export function testFunctionWithAddedErrorable(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function testFunctionWithChangedArgumentType(arg: number): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function testFunctionWithRemovedArgument(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function testFunctionWithRemovedErrorable(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function testGlobalFunction(argument1: string): number; diff --git a/tools/api-docs-generator-test-snapshots/test/closures/__snapshots__/closures.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/closures/__snapshots__/closures.spec.ts.snap index 90eefb30..e8221fcd 100644 --- a/tools/api-docs-generator-test-snapshots/test/closures/__snapshots__/closures.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/closures/__snapshots__/closures.spec.ts.snap @@ -200,6 +200,7 @@ export class ClassWithPrivilegedClosures { /** * @remarks * This closure is called with early-execution privilege. + * closureEarlyExec @early-execution-closure * */ readonly closureEarlyExec: () => void; @@ -208,6 +209,7 @@ export class ClassWithPrivilegedClosures { /** * @remarks * This closure is called with restricted-execution privilege. + * closureRestrictedExec @restricted-execution-closure * */ readonly closureRestrictedExec: () => void; @@ -215,8 +217,10 @@ export class ClassWithPrivilegedClosures { * @remarks * @param closureRestrictedExec * This closure is called with restricted-execution privilege. + * closureRestrictedExec @restricted-execution-closure * @param closureEarlyExec * This closure is called with early-execution privilege. + * closureEarlyExec @early-execution-closure */ func( closureDefaultOptional?: () => void, @@ -235,16 +239,19 @@ export class ExampleClass { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * - * This function can be called in early-execution mode. + * @early-execution-allowed This function can be called in early-execution mode. * * @param closureRestrictedExec * This closure is called with restricted-execution privilege. + * closureRestrictedExec @restricted-execution-closure * @param closureEarlyExec * This closure is called with early-execution privilege. + * closureEarlyExec @early-execution-closure * @returns * Closure that is called with restricted-execution privilege. + * globalFuncReturnsRestrictedExecClosure @restricted-execution-closure */ export function globalFuncReturnsRestrictedExecClosure( closureDefaultOptional?: () => void, diff --git a/tools/api-docs-generator-test-snapshots/test/data_buffer/__snapshots__/data_buffer.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/data_buffer/__snapshots__/data_buffer.spec.ts.snap index 13ca8f11..17e9c02a 100644 --- a/tools/api-docs-generator-test-snapshots/test/data_buffer/__snapshots__/data_buffer.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/data_buffer/__snapshots__/data_buffer.spec.ts.snap @@ -162,61 +162,61 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ doubleDataBufferProperty: Float64Array; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ floatDataBufferProperty: Float32Array; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ int16DataBufferProperty: Int16Array; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ int32DataBufferProperty: Int32Array; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ int64DataBufferProperty: BigInt64Array; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ int8DataBufferProperty: Uint8Array; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ uint16DataBufferProperty: Uint16Array; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ uint32DataBufferProperty: Uint32Array; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ uint64DataBufferProperty: BigUint64Array; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ uint8DataBufferProperty: Uint8Array; diff --git a/tools/api-docs-generator-test-snapshots/test/deprecation_warning/__snapshots__/deprecationWarning.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/deprecation_warning/__snapshots__/deprecationWarning.spec.ts.snap index 586986f0..423cc24b 100644 --- a/tools/api-docs-generator-test-snapshots/test/deprecation_warning/__snapshots__/deprecationWarning.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/deprecation_warning/__snapshots__/deprecationWarning.spec.ts.snap @@ -681,13 +681,13 @@ export class StableClassWithDeprecatedMembers { * @deprecated This property is deprecated and will be removed in 2.0.0. * * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ deprecatedProperty: boolean; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ stableProperty: boolean; @@ -700,13 +700,13 @@ export class StableClassWithDeprecatedMembers { * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ deprecatedFunction(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ stableFunction(): boolean; @@ -748,7 +748,7 @@ export class StableErrorWithDeprecatedProperty extends Error { * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function deprecatedGlobalFunction(): boolean; @@ -756,7 +756,7 @@ export function deprecatedGlobalFunction(): boolean; * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function stableGlobalFunction(): boolean; @@ -824,13 +824,13 @@ export class StableClassWithDeprecatedMembers { * @deprecated This property is deprecated and will be removed in 2.0.0. * * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ deprecatedProperty: boolean; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ stableProperty: boolean; @@ -843,13 +843,13 @@ export class StableClassWithDeprecatedMembers { * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ deprecatedFunction(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ stableFunction(): boolean; @@ -890,7 +890,7 @@ export class StableErrorWithDeprecatedProperty extends Error { /** * @beta * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function betaGlobalFunctionNotInAlpha(): boolean; @@ -898,7 +898,7 @@ export function betaGlobalFunctionNotInAlpha(): boolean; * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function deprecatedGlobalFunction(): boolean; @@ -906,7 +906,7 @@ export function deprecatedGlobalFunction(): boolean; * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function stableGlobalFunction(): boolean; @@ -948,14 +948,14 @@ export class StableClassWithDeprecatedMembers { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ stableProperty: boolean; static readonly stableConstant: boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ stableFunction(): boolean; @@ -974,7 +974,7 @@ export class StableErrorWithDeprecatedProperty extends Error { /** * @alpha * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function v2GlobalFunction(): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/errors/__snapshots__/errors.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/errors/__snapshots__/errors.spec.ts.snap index e2b4f481..d1f2d7d4 100644 --- a/tools/api-docs-generator-test-snapshots/test/errors/__snapshots__/errors.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/errors/__snapshots__/errors.spec.ts.snap @@ -429,14 +429,14 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ examplePropertyThatThrows: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * @throws This property can throw when used. * @@ -445,7 +445,7 @@ export class ExampleClass { examplePropertyThatThrowsCustomError: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * @throws This property can throw when used. * @@ -462,7 +462,7 @@ export class ExampleClass { examplePropertyThatThrowsWithReadOnlyPrivilege: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * @throws This property can throw when used. * @@ -471,7 +471,7 @@ export class ExampleClass { examplePropertyWithCrossModuleError: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * * @throws This property can throw when used. * @@ -480,20 +480,20 @@ export class ExampleClass { examplePropertyWithCrossModuleReturnAndError: minecraftexamplemodule2.CrossModuleReturn; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ exampleMethodThatTakesErrorParam(errorParam: unknown): string; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ exampleMethodThatThrows(): string; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -502,7 +502,7 @@ export class ExampleClass { exampleMethodThatThrowsCustomError(): string; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -539,14 +539,14 @@ export class ExampleError2 extends Error { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ export function exampleFunctionThatThrows(): string; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -555,7 +555,7 @@ export function exampleFunctionThatThrows(): string; export function exampleFunctionThatThrowsCustomError(): string; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -566,7 +566,7 @@ export function exampleFunctionThatThrowsCustomError(): string; export function exampleFunctionThatThrowsTwoErrors(): string; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -575,7 +575,7 @@ export function exampleFunctionThatThrowsTwoErrors(): string; export function exampleFunctionWithCrossModuleError(): number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * diff --git a/tools/api-docs-generator-test-snapshots/test/escaped_names/__snapshots__/escapedNames.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/escaped_names/__snapshots__/escapedNames.spec.ts.snap index fe3d8111..afd1e0e6 100644 --- a/tools/api-docs-generator-test-snapshots/test/escaped_names/__snapshots__/escapedNames.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/escaped_names/__snapshots__/escapedNames.spec.ts.snap @@ -242,31 +242,31 @@ export class ClassWithSpookyMemberNames { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ '5memberWithNumberStart': number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ 'member with spaces': number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ 'type': number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ 'void': number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ delete(): void; diff --git a/tools/api-docs-generator-test-snapshots/test/general/__snapshots__/general.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/general/__snapshots__/general.spec.ts.snap index f91a7419..a9c77875 100644 --- a/tools/api-docs-generator-test-snapshots/test/general/__snapshots__/general.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/general/__snapshots__/general.spec.ts.snap @@ -552,7 +552,7 @@ exports[`General > Properly generates documentation for the input > npm/types/te export class ClassWithEmptyConstructor { /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ numberProperty: number; @@ -562,14 +562,14 @@ export class ClassWithEmptyConstructor { export class ClassWithExplicitConstructor { /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ numberProperty: number; readonly readOnlyNumberProperty: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ constructor(constructorArg: string); @@ -579,7 +579,7 @@ export class ClassWithOptionalProperty { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ numberProperty: number; @@ -595,7 +595,7 @@ export interface ExampleInterface { * @remarks * This is a test function * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @example sharedExample.ts * \`\`\`typescript @@ -2320,7 +2320,7 @@ exports[`General > Properly generates documentation for the input > typedoc/clas

Constructors

constructor

Properties

numberProperty readOnlyNumberProperty -

Constructors

constructor

Properties

numberProperty

numberProperty: number

Remarks

This property can't be used in restricted-execution mode.

+

Constructors

constructor

Properties

numberProperty

numberProperty: number

Remarks

@restricted-execution-unusable This property can't be used in restricted-execution mode.

ReadonlyreadOnlyNumberProperty

readOnlyNumberProperty: number

Settings

Member Visibility

On This Page

Constructors
Properties
" `; @@ -2329,8 +2329,8 @@ exports[`General > Properly generates documentation for the input > typedoc/clas "ClassWithExplicitConstructor | Minecraft

Class ClassWithExplicitConstructor

Constructors

constructor

Properties

numberProperty readOnlyNumberProperty -

Constructors

constructor

Properties

numberProperty

numberProperty: number

Remarks

This property can't be used in restricted-execution mode.

+

Constructors

constructor

Properties

numberProperty

numberProperty: number

Remarks

@restricted-execution-unusable This property can't be used in restricted-execution mode.

ReadonlyreadOnlyNumberProperty

readOnlyNumberProperty: number

Settings

Member Visibility

On This Page

Constructors
Properties
" `; @@ -2338,14 +2338,14 @@ exports[`General > Properly generates documentation for the input > typedoc/clas exports[`General > Properly generates documentation for the input > typedoc/classes/ClassWithOptionalProperty.html 1`] = ` "ClassWithOptionalProperty | Minecraft

Class ClassWithOptionalProperty

Properties

numberProperty optionalNumberProperty? -

Properties

numberProperty

numberProperty: number

Remarks

This property can't be used in restricted-execution mode.

+

Properties

numberProperty

numberProperty: number

Remarks

@restricted-execution-unusable This property can't be used in restricted-execution mode.

Optional ReadonlyoptionalNumberProperty

optionalNumberProperty?: number

Settings

Member Visibility

On This Page

Properties
" `; exports[`General > Properly generates documentation for the input > typedoc/functions/ModuleFunction.html 1`] = ` "ModuleFunction | Minecraft

Function ModuleFunction

  • ModuleFunction(): ClassWithConstructor

  • Returns ClassWithConstructor

    Remarks

    This is a test function

    -

    This function can't be called in restricted-execution mode.

    +

    @no-restricted-execution This function can't be called in restricted-execution mode.

    Example: sharedExample.ts

    let sharedExample = true;

    /\\* This is a sample that also declares a function and has braces */
    function testFunction() {}
    @@ -2417,7 +2417,7 @@ exports[`General > Properly generates documentation for the input > typescript/t export class ClassWithEmptyConstructor { /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ numberProperty: number; @@ -2427,14 +2427,14 @@ export class ClassWithEmptyConstructor { export class ClassWithExplicitConstructor { /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ numberProperty: number; readonly readOnlyNumberProperty: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ constructor(constructorArg: string); @@ -2444,7 +2444,7 @@ export class ClassWithOptionalProperty { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ numberProperty: number; @@ -2460,7 +2460,7 @@ export interface ExampleInterface { * @remarks * This is a test function * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @example sharedExample.ts * \`\`\`typescript diff --git a/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap index fb6c60d5..59a3a806 100644 --- a/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap @@ -564,7 +564,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -573,7 +573,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -683,7 +683,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -692,7 +692,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -1054,7 +1054,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -1063,7 +1063,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -1144,7 +1144,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -1153,7 +1153,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -1802,7 +1802,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -1811,7 +1811,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -1921,7 +1921,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -1930,7 +1930,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -2123,7 +2123,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -2132,7 +2132,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -2213,7 +2213,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -2222,7 +2222,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc diff --git a/tools/api-docs-generator-test-snapshots/test/iterator/__snapshots__/iterator.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/iterator/__snapshots__/iterator.spec.ts.snap index 41fa40c8..52a2adea 100644 --- a/tools/api-docs-generator-test-snapshots/test/iterator/__snapshots__/iterator.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/iterator/__snapshots__/iterator.spec.ts.snap @@ -107,13 +107,13 @@ export class ExampleIterator implements Iterable { private constructor(); /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ [Symbol.iterator](): Iterator; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ next(): IteratorResult; diff --git a/tools/api-docs-generator-test-snapshots/test/maps/__snapshots__/maps.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/maps/__snapshots__/maps.spec.ts.snap index db73fd38..b81104a8 100644 --- a/tools/api-docs-generator-test-snapshots/test/maps/__snapshots__/maps.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/maps/__snapshots__/maps.spec.ts.snap @@ -115,19 +115,19 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ mapProperty: Record; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ exampleMethodReturnsMap(): Record; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ exampleMethodTakesMapArg(arg: Record): void; diff --git a/tools/api-docs-generator-test-snapshots/test/optionals/__snapshots__/optionals.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/optionals/__snapshots__/optionals.spec.ts.snap index b29cb5cd..49c1521b 100644 --- a/tools/api-docs-generator-test-snapshots/test/optionals/__snapshots__/optionals.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/optionals/__snapshots__/optionals.spec.ts.snap @@ -237,31 +237,31 @@ export class ClassWithOptionals { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ optionalProperty?: boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ methodThatReturnsOptional(): boolean | undefined; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ methodThatTakesOptionals(arg1?: boolean, arg2?: string): void; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ methodThatTakesRecordOfOptionalVariants(values: Record): void; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @param defaultIs1 * Defaults to: 1 diff --git a/tools/api-docs-generator-test-snapshots/test/prerelease_warning/__snapshots__/prereleaseWarning.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/prerelease_warning/__snapshots__/prereleaseWarning.spec.ts.snap index 746853ff..d38588eb 100644 --- a/tools/api-docs-generator-test-snapshots/test/prerelease_warning/__snapshots__/prereleaseWarning.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/prerelease_warning/__snapshots__/prereleaseWarning.spec.ts.snap @@ -570,14 +570,14 @@ export class StableClass { /** * @beta * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ prereleaseProperty: number; /** * @beta * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ prereleaseMethod(): number; @@ -598,7 +598,7 @@ export interface StableInterface { /** * @beta * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function prereleaseFunction(): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/property_and_function_privilege/__snapshots__/propertyAndFunctionPrivilege.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/property_and_function_privilege/__snapshots__/propertyAndFunctionPrivilege.spec.ts.snap index 647ae69b..e617ee19 100644 --- a/tools/api-docs-generator-test-snapshots/test/property_and_function_privilege/__snapshots__/propertyAndFunctionPrivilege.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/property_and_function_privilege/__snapshots__/propertyAndFunctionPrivilege.spec.ts.snap @@ -227,13 +227,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ no_privilege_property: number; /** * @remarks - * This property can't be edited in restricted-execution mode. + * @restricted-execution-read-only This property can't be edited in restricted-execution mode. * */ none_privileged_property: number; @@ -241,7 +241,7 @@ export class ExampleClass { * @remarks * Test description * - * This property can't be edited in restricted-execution mode. + * @restricted-execution-read-only This property can't be edited in restricted-execution mode. * */ none_privileged_property_with_docs: number; @@ -249,21 +249,21 @@ export class ExampleClass { readonly read_only_property: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * - * This function can be called in early-execution mode. + * @early-execution-allowed This function can be called in early-execution mode. * */ early_privileged_function(): boolean; /** * @remarks - * This function can be called in early-execution mode. + * @early-execution-allowed This function can be called in early-execution mode. * */ multi_privileged_function(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ non_privileged_function(): boolean; @@ -271,7 +271,7 @@ export class ExampleClass { * @remarks * Test description * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ non_privileged_function_with_comments(): boolean; @@ -280,21 +280,21 @@ export class ExampleClass { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * - * This function can be called in early-execution mode. + * @early-execution-allowed This function can be called in early-execution mode. * */ export function early_privileged_function(): boolean; /** * @remarks - * This function can be called in early-execution mode. + * @early-execution-allowed This function can be called in early-execution mode. * */ export function multi_privileged_function(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function non_privileged_function(): boolean; @@ -302,7 +302,7 @@ export function non_privileged_function(): boolean; * @remarks * Test description * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function non_privileged_function_with_comments(): boolean; @@ -1536,70 +1536,70 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can be used in early-execution mode. + * @early-execution-usable This property can be used in early-execution mode. * */ prop_both_privileges: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * - * This property can be used in early-execution mode. + * @early-execution-usable This property can be used in early-execution mode. * */ prop_earlyexe_privilege: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * - * This property can be read in early-execution mode. + * @early-execution-readable This property can be read in early-execution mode. * */ prop_getearlyexe_privileges: number; /** * @remarks - * This property can't be edited in restricted-execution mode. + * @restricted-execution-read-only This property can't be edited in restricted-execution mode. * */ prop_getreadonly_privileges: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ prop_none_privilege: number; prop_readonly_privilege: number; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * - * This property can be edited in early-execution mode. + * @early-execution-editable This property can be edited in early-execution mode. * */ prop_setearlyexe_privileges: number; /** * @remarks - * This property can't be read in restricted-execution mode. + * @restricted-execution-non-readable This property can't be read in restricted-execution mode. * */ prop_setreadonly_privileges: number; /** * @remarks - * This function can be called in early-execution mode. + * @early-execution-allowed This function can be called in early-execution mode. * */ memberfn_both_privileges(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * - * This function can be called in early-execution mode. + * @early-execution-allowed This function can be called in early-execution mode. * */ memberfn_earlyexe_privilege(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ memberfn_none_privilege(): boolean; @@ -1608,21 +1608,21 @@ export class ExampleClass { /** * @remarks - * This function can be called in early-execution mode. + * @early-execution-allowed This function can be called in early-execution mode. * */ export function fn_both_privileges(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * - * This function can be called in early-execution mode. + * @early-execution-allowed This function can be called in early-execution mode. * */ export function fn_earlyexe_privilege(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function fn_none_privilege(): boolean; @@ -1813,13 +1813,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ no_privilege_property: number; /** * @remarks - * This property can't be edited in restricted-execution mode. + * @restricted-execution-read-only This property can't be edited in restricted-execution mode. * */ none_privileged_property: number; @@ -1827,7 +1827,7 @@ export class ExampleClass { * @remarks * Test description * - * This property can't be edited in restricted-execution mode. + * @restricted-execution-read-only This property can't be edited in restricted-execution mode. * */ none_privileged_property_with_docs: number; @@ -1835,7 +1835,7 @@ export class ExampleClass { readonly read_only_property: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ non_privileged_function(): boolean; @@ -1843,7 +1843,7 @@ export class ExampleClass { * @remarks * Test description * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ non_privileged_function_with_comments(): boolean; @@ -1852,7 +1852,7 @@ export class ExampleClass { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function non_privileged_function(): boolean; @@ -1860,7 +1860,7 @@ export function non_privileged_function(): boolean; * @remarks * Test description * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function non_privileged_function_with_comments(): boolean; @@ -2101,42 +2101,42 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be edited in restricted-execution mode. + * @restricted-execution-read-only This property can't be edited in restricted-execution mode. * */ both_none_name_prop: number; both_read_only_name_prop: number; /** * @remarks - * This property can't be edited in restricted-execution mode. + * @restricted-execution-read-only This property can't be edited in restricted-execution mode. * */ new_default_name_prop: number; new_restrict_name_prop: number; /** * @remarks - * This property can't be edited in restricted-execution mode. + * @restricted-execution-read-only This property can't be edited in restricted-execution mode. * */ old_none_name_prop: number; old_read_only_name_prop: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ both_none_name_func(): boolean; both_read_only_name_func(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ new_default_name_func(): boolean; new_restrict_name_func(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ old_none_name_func(): boolean; @@ -2145,21 +2145,21 @@ export class ExampleClass { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function both_none_name_func(): boolean; export function both_read_only_name_func(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function new_default_name_func(): boolean; export function new_restrict_name_func(): boolean; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function old_none_name_func(): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/record_of_optional_variants/__snapshots__/recordOfOptionalVariants.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/record_of_optional_variants/__snapshots__/recordOfOptionalVariants.spec.ts.snap index 77498a5c..8e785756 100644 --- a/tools/api-docs-generator-test-snapshots/test/record_of_optional_variants/__snapshots__/recordOfOptionalVariants.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/record_of_optional_variants/__snapshots__/recordOfOptionalVariants.spec.ts.snap @@ -90,7 +90,7 @@ export class ClassWithRecordOfOptionalVariantsProperty { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ exampleMember?: Record; diff --git a/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap index 33a454da..e0934025 100644 --- a/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap @@ -248,7 +248,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -257,7 +257,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc diff --git a/tools/api-docs-generator-test-snapshots/test/skip_merging_with_parent/__snapshots__/skipMerging.test.ts.snap b/tools/api-docs-generator-test-snapshots/test/skip_merging_with_parent/__snapshots__/skipMerging.test.ts.snap index a7f64962..56256323 100644 --- a/tools/api-docs-generator-test-snapshots/test/skip_merging_with_parent/__snapshots__/skipMerging.test.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/skip_merging_with_parent/__snapshots__/skipMerging.test.ts.snap @@ -26,7 +26,7 @@ exports[`Skip Merging With Parent > Properly skips merging if skip merging is se */ /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function ChildFunction(): number; @@ -57,7 +57,7 @@ exports[`Skip Merging With Parent > Properly skips merging if skip merging is se */ /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function ParentFunction(): number; diff --git a/tools/api-docs-generator-test-snapshots/test/skip_merging_without_parent/__snapshots__/skipMerging.test.ts.snap b/tools/api-docs-generator-test-snapshots/test/skip_merging_without_parent/__snapshots__/skipMerging.test.ts.snap index c1c70189..7afb1111 100644 --- a/tools/api-docs-generator-test-snapshots/test/skip_merging_without_parent/__snapshots__/skipMerging.test.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/skip_merging_without_parent/__snapshots__/skipMerging.test.ts.snap @@ -26,7 +26,7 @@ exports[`Skip Merging Without Parent > Properly skips merging if skip merging is */ /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function ChildFunction(): number; diff --git a/tools/api-docs-generator-test-snapshots/test/static_functions/__snapshots__/staticFunctions.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/static_functions/__snapshots__/staticFunctions.spec.ts.snap index 701cad58..8e2dca13 100644 --- a/tools/api-docs-generator-test-snapshots/test/static_functions/__snapshots__/staticFunctions.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/static_functions/__snapshots__/staticFunctions.spec.ts.snap @@ -126,25 +126,25 @@ export class ClassWithStaticFunction { private constructor(); /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ bbbExampleMemberFunction(): string; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ dddExampleMemberFunction(): string; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ static aaaExampleStaticFunction(): string; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ static cccExampleStaticFunction(): string; diff --git a/tools/api-docs-generator-test-snapshots/test/type_linking/__snapshots__/typeLinking.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/type_linking/__snapshots__/typeLinking.spec.ts.snap index 4df7b129..3dce7fbf 100644 --- a/tools/api-docs-generator-test-snapshots/test/type_linking/__snapshots__/typeLinking.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/type_linking/__snapshots__/typeLinking.spec.ts.snap @@ -868,13 +868,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -890,7 +890,7 @@ export interface ExampleInterface { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -960,13 +960,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -982,7 +982,7 @@ export interface ExampleInterface { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -1147,13 +1147,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -1169,7 +1169,7 @@ export interface ExampleInterface { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -2313,13 +2313,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2335,7 +2335,7 @@ export interface ExampleInterface { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -2405,13 +2405,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2427,7 +2427,7 @@ export interface ExampleInterface { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -2592,13 +2592,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2614,7 +2614,7 @@ export interface ExampleInterface { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -2668,13 +2668,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2690,7 +2690,7 @@ export interface ExampleInterface { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -2744,13 +2744,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2766,7 +2766,7 @@ export interface ExampleInterface { /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/variants/__snapshots__/variants.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/variants/__snapshots__/variants.spec.ts.snap index d8f96057..49ad5644 100644 --- a/tools/api-docs-generator-test-snapshots/test/variants/__snapshots__/variants.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/variants/__snapshots__/variants.spec.ts.snap @@ -127,13 +127,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ propertyFunctionThatReturnsVariant: (arg0: number) => number | string; /** * @remarks - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * */ propertyFunctionThatReturnsVariantWithClosureThatReturnsVariant: ( @@ -141,13 +141,13 @@ export class ExampleClass { ) => (arg0: number) => (number | string) | string; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ exampleMethod(arg1: (arg0: number) => (arg0: number) => (number | string) | string, arg2: number): void; /** * @remarks - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * */ methodWithVariantOfArrays(arrays: number[] | string[]): boolean; diff --git a/tools/markup-generators-plugin/templates/tsdef/function.mustache b/tools/markup-generators-plugin/templates/tsdef/function.mustache index 08b0ec84..caddd86f 100644 --- a/tools/markup-generators-plugin/templates/tsdef/function.mustache +++ b/tools/markup-generators-plugin/templates/tsdef/function.mustache @@ -24,11 +24,11 @@ * {{/function_description_ts.length}} {{#call_disallowed_in_restricted_execution}} - * This function can't be called in restricted-execution mode. + * @no-restricted-execution This function can't be called in restricted-execution mode. * {{/call_disallowed_in_restricted_execution}} {{#call_allowed_in_early_execution}} - * This function can be called in early-execution mode. + * @early-execution-allowed This function can be called in early-execution mode. * {{/call_allowed_in_early_execution}} {{/ts_has_remarks}} @@ -42,6 +42,7 @@ {{/argument_description_ts.length}} {{#has_closure_privilege_type_comments}} * This closure is called with {{closure_privilege_type_name}} privilege. + * {{{name}}} @{{closure_privilege_type_name}}-closure {{/has_closure_privilege_type_comments}} {{#has_defaults}} {{#details.default_value}} @@ -68,12 +69,14 @@ {{/returns_description_ts}} {{#return_type_has_closure_privilege_type_comments}} * Closure that is called with {{return_type_closure_privilege_type_name}} privilege. + * {{{name}}} @{{return_type_closure_privilege_type_name}}-closure {{/return_type_has_closure_privilege_type_comments}} {{/returns_description_ts.length}} {{^returns_description_ts.length}} {{#return_type_has_closure_privilege_type_comments}} * @returns * Closure that is called with {{return_type_closure_privilege_type_name}} privilege. + * {{{name}}} @{{return_type_closure_privilege_type_name}}-closure {{/return_type_has_closure_privilege_type_comments}} {{/returns_description_ts.length}} {{#has_runtime_conditions}} diff --git a/tools/markup-generators-plugin/templates/tsdef/property.mustache b/tools/markup-generators-plugin/templates/tsdef/property.mustache index c2772080..03c3d0fd 100644 --- a/tools/markup-generators-plugin/templates/tsdef/property.mustache +++ b/tools/markup-generators-plugin/templates/tsdef/property.mustache @@ -25,37 +25,38 @@ {{/property_description_ts.length}} {{#has_closure_privilege_type_comments}} * This closure is called with {{closure_privilege_type_name}} privilege. + * {{property_name}} @{{closure_privilege_type_name}}-closure * {{/has_closure_privilege_type_comments}} {{#set_disallowed_in_restricted_execution}} {{#get_disallowed_in_restricted_execution}} - * This property can't be used in restricted-execution mode. + * @restricted-execution-unusable This property can't be used in restricted-execution mode. * {{/get_disallowed_in_restricted_execution}} {{^get_disallowed_in_restricted_execution}} - * This property can't be edited in restricted-execution mode. + * @restricted-execution-read-only This property can't be edited in restricted-execution mode. * {{/get_disallowed_in_restricted_execution}} {{/set_disallowed_in_restricted_execution}} {{^set_disallowed_in_restricted_execution}} {{#get_disallowed_in_restricted_execution}} - * This property can't be read in restricted-execution mode. + * @restricted-execution-non-readable This property can't be read in restricted-execution mode. * {{/get_disallowed_in_restricted_execution}} {{/set_disallowed_in_restricted_execution}} {{#set_allowed_in_early_execution}} {{#get_allowed_in_early_execution}} - * This property can be used in early-execution mode. + * @early-execution-usable This property can be used in early-execution mode. * {{/get_allowed_in_early_execution}} {{^get_allowed_in_early_execution}} - * This property can be edited in early-execution mode. + * @early-execution-editable This property can be edited in early-execution mode. * {{/get_allowed_in_early_execution}} {{/set_allowed_in_early_execution}} {{^set_allowed_in_early_execution}} {{#get_allowed_in_early_execution}} - * This property can be read in early-execution mode. + * @early-execution-readable This property can be read in early-execution mode. * {{/get_allowed_in_early_execution}} {{/set_allowed_in_early_execution}} From c17ee9a5157fd81adc294553ad685da5746847b4 Mon Sep 17 00:00:00 2001 From: Brandon Chan Date: Tue, 7 Jul 2026 16:17:43 -0700 Subject: [PATCH 2/4] Change files --- ...rators-plugin-de097a3a-1fb3-4d2d-8505-133ae7789860.json | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 change/@minecraft-markup-generators-plugin-de097a3a-1fb3-4d2d-8505-133ae7789860.json diff --git a/change/@minecraft-markup-generators-plugin-de097a3a-1fb3-4d2d-8505-133ae7789860.json b/change/@minecraft-markup-generators-plugin-de097a3a-1fb3-4d2d-8505-133ae7789860.json new file mode 100644 index 00000000..6661299c --- /dev/null +++ b/change/@minecraft-markup-generators-plugin-de097a3a-1fb3-4d2d-8505-133ae7789860.json @@ -0,0 +1,7 @@ +{ + "type": "patch", + "comment": "Add tags for priviledge levels", + "packageName": "@minecraft/markup-generators-plugin", + "email": "brandon.chan@skyboxlabs.com", + "dependentChangeType": "patch" +} From 99de43a70365466c6f95d4665ad56cd5c35ceb95 Mon Sep 17 00:00:00 2001 From: Brandon Chan Date: Thu, 9 Jul 2026 14:08:12 -0700 Subject: [PATCH 3/4] Update tag --- .../additiveBetaChange.spec.ts.snap | 4 +- .../arrayOfOptionalVariants.spec.ts.snap | 2 +- .../arrayOfVariants.spec.ts.snap | 2 +- .../bounds/__snapshots__/bounds.spec.ts.snap | 40 ++--- .../changelogDiffing.spec.ts.snap | 142 +++++++++--------- .../__snapshots__/closures.spec.ts.snap | 11 +- .../__snapshots__/data_buffer.spec.ts.snap | 20 +-- .../deprecationWarning.spec.ts.snap | 32 ++-- .../errors/__snapshots__/errors.spec.ts.snap | 28 ++-- .../__snapshots__/escapedNames.spec.ts.snap | 10 +- .../__snapshots__/general.spec.ts.snap | 30 ++-- .../hybrid_script_native_module.spec.ts.snap | 32 ++-- .../__snapshots__/iterator.spec.ts.snap | 4 +- .../test/maps/__snapshots__/maps.spec.ts.snap | 6 +- .../__snapshots__/optionals.spec.ts.snap | 10 +- .../prereleaseWarning.spec.ts.snap | 6 +- .../propertyAndFunctionPrivilege.spec.ts.snap | 94 ++++++------ .../recordOfOptionalVariants.spec.ts.snap | 2 +- .../script_generated_module.spec.ts.snap | 4 +- .../__snapshots__/skipMerging.test.ts.snap | 4 +- .../__snapshots__/skipMerging.test.ts.snap | 2 +- .../staticFunctions.spec.ts.snap | 8 +- .../__snapshots__/typeLinking.spec.ts.snap | 48 +++--- .../__snapshots__/variants.spec.ts.snap | 8 +- .../templates/tsdef/function.mustache | 7 +- .../templates/tsdef/property.mustache | 13 +- 26 files changed, 279 insertions(+), 290 deletions(-) diff --git a/tools/api-docs-generator-test-snapshots/test/additive_beta_change/__snapshots__/additiveBetaChange.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/additive_beta_change/__snapshots__/additiveBetaChange.spec.ts.snap index a21c0122..5cad6a83 100644 --- a/tools/api-docs-generator-test-snapshots/test/additive_beta_change/__snapshots__/additiveBetaChange.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/additive_beta_change/__snapshots__/additiveBetaChange.spec.ts.snap @@ -187,7 +187,7 @@ export class ExampleClass1 { private constructor(); /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithAddedArgument(): boolean; @@ -226,7 +226,7 @@ export class ExampleClass1 { private constructor(); /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithAddedArgument(addedArg?: number): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/array_of_optional_variants/__snapshots__/arrayOfOptionalVariants.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/array_of_optional_variants/__snapshots__/arrayOfOptionalVariants.spec.ts.snap index dde06029..f8deb5e6 100644 --- a/tools/api-docs-generator-test-snapshots/test/array_of_optional_variants/__snapshots__/arrayOfOptionalVariants.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/array_of_optional_variants/__snapshots__/arrayOfOptionalVariants.spec.ts.snap @@ -90,7 +90,7 @@ export class ClassWithArrayOfVariantsProperty { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ exampleMember?: (boolean | number | string | undefined)[]; diff --git a/tools/api-docs-generator-test-snapshots/test/array_of_variants/__snapshots__/arrayOfVariants.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/array_of_variants/__snapshots__/arrayOfVariants.spec.ts.snap index 1a163930..7ebdd79f 100644 --- a/tools/api-docs-generator-test-snapshots/test/array_of_variants/__snapshots__/arrayOfVariants.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/array_of_variants/__snapshots__/arrayOfVariants.spec.ts.snap @@ -90,7 +90,7 @@ export class ClassWithArrayOfVariantsProperty { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ exampleMember?: (boolean | string)[]; diff --git a/tools/api-docs-generator-test-snapshots/test/bounds/__snapshots__/bounds.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/bounds/__snapshots__/bounds.spec.ts.snap index e5275925..55db474b 100644 --- a/tools/api-docs-generator-test-snapshots/test/bounds/__snapshots__/bounds.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/bounds/__snapshots__/bounds.spec.ts.snap @@ -479,68 +479,68 @@ export class ClassWithBounds { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Bounds: [0, 0] */ r: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Minimum Value: -255 */ s: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Maximum Value: 1 */ t: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ u: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Bounds: [-255, -1] */ v: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ w: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Minimum Value: 1 */ x: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Maximum Value: 255 */ y: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Bounds: [1, 255] */ z: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param s * Minimum value: -255 @@ -602,68 +602,68 @@ export class ClassWithBounds { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Bounds: [0, 0] */ r: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Minimum Value: 1 */ s: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Maximum Value: 255 */ t: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ u: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Bounds: [1, 255] */ v: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Bounds: [1, 255] */ w: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Maximum Value: 255 */ x: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Minimum Value: 1 */ y: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ z: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param s * Minimum value: 1 diff --git a/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap index 1d880404..e4637bde 100644 --- a/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap @@ -4079,7 +4079,7 @@ export class ClassWithCrossModuleProperty { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ exampleProperty: testmodule1.SmallClass; @@ -4117,7 +4117,7 @@ export class ClassWithCrossModuleProperty { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ exampleProperty: testmodule1.SmallClass; @@ -4155,7 +4155,7 @@ export class ClassWithCrossModuleProperty { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ exampleProperty: testmodule1.SmallClass; @@ -4250,25 +4250,25 @@ export class ClassWithAddedBaseClass { export class ClassWithConstructor { /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ x: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ y: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ z: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ constructor(x: number, y: number, z: number); @@ -4283,13 +4283,13 @@ export class EntityIterator implements Iterable { private constructor(); /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ [Symbol.iterator](): Iterator; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ next(): IteratorResult; @@ -4299,43 +4299,43 @@ export class ExampleClass1 { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ boolProperty: boolean; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ floatProperty: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int16Property: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int32Property: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int64Property: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int8Property: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4343,13 +4343,13 @@ export class ExampleClass1 { readonly propertyWithReadOnlyChanging: string; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ stringProperty: string; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4357,68 +4357,68 @@ export class ExampleClass1 { readonly stringPropertyReadOnly: string; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint16Property: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint32Property: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint64Property: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint8Property: number; static readonly ClassConstantExample = 1337; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethod(stringArgument: string, stringArgumentOptional?: string): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithAddedArgument(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithAddedErrorable(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithChangedArgumentType(arg: string): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithChangedReturnType(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithRemovedArgument(removedArg: string): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ @@ -4429,7 +4429,7 @@ export class SmallClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4452,31 +4452,31 @@ export interface RemovedInterface { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithAddedArgument(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithAddedErrorable(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithChangedArgumentType(arg: string): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithRemovedArgument(removedArg: string): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ @@ -4554,37 +4554,37 @@ export class ClassWithAddedBaseClass extends SmallClass { export class ClassWithConstructor { /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ w: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ x: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ y: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ z: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ constructor(x: number, y: number, z: number); /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testFunction(argument1: string, argument2: string): number; @@ -4598,13 +4598,13 @@ export class EntityIterator implements Iterable { private constructor(); /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ [Symbol.iterator](): Iterator; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ next(): IteratorResult; @@ -4614,62 +4614,62 @@ export class ExampleClass1 { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ boolProperty: boolean; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ floatProperty: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int16Property: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int32Property: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int64Property: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int8Property: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ propertyWithChangedType: boolean; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ propertyWithReadOnlyChanging: string; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ stringProperty: string; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4677,69 +4677,69 @@ export class ExampleClass1 { readonly stringPropertyReadOnly: string; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint16Property: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint32Property: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint64Property: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint8Property: number; static readonly ClassConstantExample = 1338; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethod(stringArgument: string, stringArgumentOptional?: string): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithAddedArgument(addedArg: string): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ testMethodWithAddedErrorable(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithChangedArgumentType(arg: number): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithChangedReturnType(): string; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithRemovedArgument(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithRemovedErrorable(): boolean; @@ -4749,7 +4749,7 @@ export class SmallClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4766,38 +4766,38 @@ export interface ExampleInterface { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithAddedArgument(addedArg: string): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ export function testFunctionWithAddedErrorable(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithChangedArgumentType(arg: number): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithRemovedArgument(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithRemovedErrorable(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testGlobalFunction(argument1: string): number; diff --git a/tools/api-docs-generator-test-snapshots/test/closures/__snapshots__/closures.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/closures/__snapshots__/closures.spec.ts.snap index e8221fcd..abfbe29e 100644 --- a/tools/api-docs-generator-test-snapshots/test/closures/__snapshots__/closures.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/closures/__snapshots__/closures.spec.ts.snap @@ -200,7 +200,6 @@ export class ClassWithPrivilegedClosures { /** * @remarks * This closure is called with early-execution privilege. - * closureEarlyExec @early-execution-closure * */ readonly closureEarlyExec: () => void; @@ -209,7 +208,6 @@ export class ClassWithPrivilegedClosures { /** * @remarks * This closure is called with restricted-execution privilege. - * closureRestrictedExec @restricted-execution-closure * */ readonly closureRestrictedExec: () => void; @@ -217,10 +215,8 @@ export class ClassWithPrivilegedClosures { * @remarks * @param closureRestrictedExec * This closure is called with restricted-execution privilege. - * closureRestrictedExec @restricted-execution-closure * @param closureEarlyExec * This closure is called with early-execution privilege. - * closureEarlyExec @early-execution-closure */ func( closureDefaultOptional?: () => void, @@ -239,19 +235,16 @@ export class ExampleClass { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * - * @early-execution-allowed This function can be called in early-execution mode. + * @privelege early-execution-allowed. This function can be called in early-execution mode. * * @param closureRestrictedExec * This closure is called with restricted-execution privilege. - * closureRestrictedExec @restricted-execution-closure * @param closureEarlyExec * This closure is called with early-execution privilege. - * closureEarlyExec @early-execution-closure * @returns * Closure that is called with restricted-execution privilege. - * globalFuncReturnsRestrictedExecClosure @restricted-execution-closure */ export function globalFuncReturnsRestrictedExecClosure( closureDefaultOptional?: () => void, diff --git a/tools/api-docs-generator-test-snapshots/test/data_buffer/__snapshots__/data_buffer.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/data_buffer/__snapshots__/data_buffer.spec.ts.snap index 17e9c02a..af8640d3 100644 --- a/tools/api-docs-generator-test-snapshots/test/data_buffer/__snapshots__/data_buffer.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/data_buffer/__snapshots__/data_buffer.spec.ts.snap @@ -162,61 +162,61 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ doubleDataBufferProperty: Float64Array; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ floatDataBufferProperty: Float32Array; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int16DataBufferProperty: Int16Array; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int32DataBufferProperty: Int32Array; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int64DataBufferProperty: BigInt64Array; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int8DataBufferProperty: Uint8Array; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint16DataBufferProperty: Uint16Array; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint32DataBufferProperty: Uint32Array; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint64DataBufferProperty: BigUint64Array; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint8DataBufferProperty: Uint8Array; diff --git a/tools/api-docs-generator-test-snapshots/test/deprecation_warning/__snapshots__/deprecationWarning.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/deprecation_warning/__snapshots__/deprecationWarning.spec.ts.snap index 423cc24b..56e927eb 100644 --- a/tools/api-docs-generator-test-snapshots/test/deprecation_warning/__snapshots__/deprecationWarning.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/deprecation_warning/__snapshots__/deprecationWarning.spec.ts.snap @@ -681,13 +681,13 @@ export class StableClassWithDeprecatedMembers { * @deprecated This property is deprecated and will be removed in 2.0.0. * * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ deprecatedProperty: boolean; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ stableProperty: boolean; @@ -700,13 +700,13 @@ export class StableClassWithDeprecatedMembers { * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ deprecatedFunction(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ stableFunction(): boolean; @@ -748,7 +748,7 @@ export class StableErrorWithDeprecatedProperty extends Error { * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function deprecatedGlobalFunction(): boolean; @@ -756,7 +756,7 @@ export function deprecatedGlobalFunction(): boolean; * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function stableGlobalFunction(): boolean; @@ -824,13 +824,13 @@ export class StableClassWithDeprecatedMembers { * @deprecated This property is deprecated and will be removed in 2.0.0. * * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ deprecatedProperty: boolean; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ stableProperty: boolean; @@ -843,13 +843,13 @@ export class StableClassWithDeprecatedMembers { * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ deprecatedFunction(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ stableFunction(): boolean; @@ -890,7 +890,7 @@ export class StableErrorWithDeprecatedProperty extends Error { /** * @beta * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function betaGlobalFunctionNotInAlpha(): boolean; @@ -898,7 +898,7 @@ export function betaGlobalFunctionNotInAlpha(): boolean; * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function deprecatedGlobalFunction(): boolean; @@ -906,7 +906,7 @@ export function deprecatedGlobalFunction(): boolean; * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function stableGlobalFunction(): boolean; @@ -948,14 +948,14 @@ export class StableClassWithDeprecatedMembers { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ stableProperty: boolean; static readonly stableConstant: boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ stableFunction(): boolean; @@ -974,7 +974,7 @@ export class StableErrorWithDeprecatedProperty extends Error { /** * @alpha * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function v2GlobalFunction(): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/errors/__snapshots__/errors.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/errors/__snapshots__/errors.spec.ts.snap index d1f2d7d4..67f6d2fe 100644 --- a/tools/api-docs-generator-test-snapshots/test/errors/__snapshots__/errors.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/errors/__snapshots__/errors.spec.ts.snap @@ -429,14 +429,14 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ examplePropertyThatThrows: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. * @@ -445,7 +445,7 @@ export class ExampleClass { examplePropertyThatThrowsCustomError: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. * @@ -462,7 +462,7 @@ export class ExampleClass { examplePropertyThatThrowsWithReadOnlyPrivilege: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. * @@ -471,7 +471,7 @@ export class ExampleClass { examplePropertyWithCrossModuleError: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. * @@ -480,20 +480,20 @@ export class ExampleClass { examplePropertyWithCrossModuleReturnAndError: minecraftexamplemodule2.CrossModuleReturn; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ exampleMethodThatTakesErrorParam(errorParam: unknown): string; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ exampleMethodThatThrows(): string; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -502,7 +502,7 @@ export class ExampleClass { exampleMethodThatThrowsCustomError(): string; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -539,14 +539,14 @@ export class ExampleError2 extends Error { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ export function exampleFunctionThatThrows(): string; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -555,7 +555,7 @@ export function exampleFunctionThatThrows(): string; export function exampleFunctionThatThrowsCustomError(): string; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -566,7 +566,7 @@ export function exampleFunctionThatThrowsCustomError(): string; export function exampleFunctionThatThrowsTwoErrors(): string; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -575,7 +575,7 @@ export function exampleFunctionThatThrowsTwoErrors(): string; export function exampleFunctionWithCrossModuleError(): number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * diff --git a/tools/api-docs-generator-test-snapshots/test/escaped_names/__snapshots__/escapedNames.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/escaped_names/__snapshots__/escapedNames.spec.ts.snap index afd1e0e6..681f4006 100644 --- a/tools/api-docs-generator-test-snapshots/test/escaped_names/__snapshots__/escapedNames.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/escaped_names/__snapshots__/escapedNames.spec.ts.snap @@ -242,31 +242,31 @@ export class ClassWithSpookyMemberNames { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ '5memberWithNumberStart': number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ 'member with spaces': number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ 'type': number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ 'void': number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ delete(): void; diff --git a/tools/api-docs-generator-test-snapshots/test/general/__snapshots__/general.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/general/__snapshots__/general.spec.ts.snap index a9c77875..7843131a 100644 --- a/tools/api-docs-generator-test-snapshots/test/general/__snapshots__/general.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/general/__snapshots__/general.spec.ts.snap @@ -552,7 +552,7 @@ exports[`General > Properly generates documentation for the input > npm/types/te export class ClassWithEmptyConstructor { /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ numberProperty: number; @@ -562,14 +562,14 @@ export class ClassWithEmptyConstructor { export class ClassWithExplicitConstructor { /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ numberProperty: number; readonly readOnlyNumberProperty: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ constructor(constructorArg: string); @@ -579,7 +579,7 @@ export class ClassWithOptionalProperty { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ numberProperty: number; @@ -595,7 +595,7 @@ export interface ExampleInterface { * @remarks * This is a test function * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @example sharedExample.ts * \`\`\`typescript @@ -2320,7 +2320,7 @@ exports[`General > Properly generates documentation for the input > typedoc/clas

Constructors

constructor

Properties

numberProperty readOnlyNumberProperty -

Constructors

constructor

Properties

numberProperty

numberProperty: number

Remarks

@restricted-execution-unusable This property can't be used in restricted-execution mode.

+

Constructors

constructor

Properties

numberProperty

numberProperty: number

Remarks

Privelege

restricted-execution-unusable. This property can't be used in restricted-execution mode.

ReadonlyreadOnlyNumberProperty

readOnlyNumberProperty: number

Settings

Member Visibility

On This Page

Constructors
Properties
" `; @@ -2329,8 +2329,8 @@ exports[`General > Properly generates documentation for the input > typedoc/clas "ClassWithExplicitConstructor | Minecraft

Class ClassWithExplicitConstructor

Constructors

constructor

Properties

numberProperty readOnlyNumberProperty -

Constructors

constructor

Properties

numberProperty

numberProperty: number

Remarks

@restricted-execution-unusable This property can't be used in restricted-execution mode.

+

Constructors

constructor

Properties

numberProperty

numberProperty: number

Remarks

Privelege

restricted-execution-unusable. This property can't be used in restricted-execution mode.

ReadonlyreadOnlyNumberProperty

readOnlyNumberProperty: number

Settings

Member Visibility

On This Page

Constructors
Properties
" `; @@ -2338,14 +2338,14 @@ exports[`General > Properly generates documentation for the input > typedoc/clas exports[`General > Properly generates documentation for the input > typedoc/classes/ClassWithOptionalProperty.html 1`] = ` "ClassWithOptionalProperty | Minecraft

Class ClassWithOptionalProperty

Properties

numberProperty optionalNumberProperty? -

Properties

numberProperty

numberProperty: number

Remarks

@restricted-execution-unusable This property can't be used in restricted-execution mode.

+

Properties

numberProperty

numberProperty: number

Remarks

Privelege

restricted-execution-unusable. This property can't be used in restricted-execution mode.

Optional ReadonlyoptionalNumberProperty

optionalNumberProperty?: number

Settings

Member Visibility

On This Page

Properties
" `; exports[`General > Properly generates documentation for the input > typedoc/functions/ModuleFunction.html 1`] = ` "ModuleFunction | Minecraft

Function ModuleFunction

  • ModuleFunction(): ClassWithConstructor

  • Returns ClassWithConstructor

    Remarks

    This is a test function

    -

    @no-restricted-execution This function can't be called in restricted-execution mode.

    +

    Privelege

    no-restricted-execution. This function can't be called in restricted-execution mode.

    Example: sharedExample.ts

    let sharedExample = true;

    /\\* This is a sample that also declares a function and has braces */
    function testFunction() {}
    @@ -2417,7 +2417,7 @@ exports[`General > Properly generates documentation for the input > typescript/t export class ClassWithEmptyConstructor { /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ numberProperty: number; @@ -2427,14 +2427,14 @@ export class ClassWithEmptyConstructor { export class ClassWithExplicitConstructor { /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ numberProperty: number; readonly readOnlyNumberProperty: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ constructor(constructorArg: string); @@ -2444,7 +2444,7 @@ export class ClassWithOptionalProperty { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ numberProperty: number; @@ -2460,7 +2460,7 @@ export interface ExampleInterface { * @remarks * This is a test function * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @example sharedExample.ts * \`\`\`typescript diff --git a/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap index 59a3a806..54741af0 100644 --- a/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap @@ -564,7 +564,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -573,7 +573,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -683,7 +683,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -692,7 +692,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -1054,7 +1054,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -1063,7 +1063,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -1144,7 +1144,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -1153,7 +1153,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -1802,7 +1802,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -1811,7 +1811,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -1921,7 +1921,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -1930,7 +1930,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -2123,7 +2123,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -2132,7 +2132,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -2213,7 +2213,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -2222,7 +2222,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc diff --git a/tools/api-docs-generator-test-snapshots/test/iterator/__snapshots__/iterator.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/iterator/__snapshots__/iterator.spec.ts.snap index 52a2adea..10fe36ca 100644 --- a/tools/api-docs-generator-test-snapshots/test/iterator/__snapshots__/iterator.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/iterator/__snapshots__/iterator.spec.ts.snap @@ -107,13 +107,13 @@ export class ExampleIterator implements Iterable { private constructor(); /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ [Symbol.iterator](): Iterator; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ next(): IteratorResult; diff --git a/tools/api-docs-generator-test-snapshots/test/maps/__snapshots__/maps.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/maps/__snapshots__/maps.spec.ts.snap index b81104a8..a5eee16b 100644 --- a/tools/api-docs-generator-test-snapshots/test/maps/__snapshots__/maps.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/maps/__snapshots__/maps.spec.ts.snap @@ -115,19 +115,19 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ mapProperty: Record; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ exampleMethodReturnsMap(): Record; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ exampleMethodTakesMapArg(arg: Record): void; diff --git a/tools/api-docs-generator-test-snapshots/test/optionals/__snapshots__/optionals.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/optionals/__snapshots__/optionals.spec.ts.snap index 49c1521b..af8b674d 100644 --- a/tools/api-docs-generator-test-snapshots/test/optionals/__snapshots__/optionals.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/optionals/__snapshots__/optionals.spec.ts.snap @@ -237,31 +237,31 @@ export class ClassWithOptionals { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ optionalProperty?: boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ methodThatReturnsOptional(): boolean | undefined; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ methodThatTakesOptionals(arg1?: boolean, arg2?: string): void; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ methodThatTakesRecordOfOptionalVariants(values: Record): void; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param defaultIs1 * Defaults to: 1 diff --git a/tools/api-docs-generator-test-snapshots/test/prerelease_warning/__snapshots__/prereleaseWarning.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/prerelease_warning/__snapshots__/prereleaseWarning.spec.ts.snap index d38588eb..05b9008f 100644 --- a/tools/api-docs-generator-test-snapshots/test/prerelease_warning/__snapshots__/prereleaseWarning.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/prerelease_warning/__snapshots__/prereleaseWarning.spec.ts.snap @@ -570,14 +570,14 @@ export class StableClass { /** * @beta * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ prereleaseProperty: number; /** * @beta * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ prereleaseMethod(): number; @@ -598,7 +598,7 @@ export interface StableInterface { /** * @beta * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function prereleaseFunction(): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/property_and_function_privilege/__snapshots__/propertyAndFunctionPrivilege.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/property_and_function_privilege/__snapshots__/propertyAndFunctionPrivilege.spec.ts.snap index e617ee19..fefbbf97 100644 --- a/tools/api-docs-generator-test-snapshots/test/property_and_function_privilege/__snapshots__/propertyAndFunctionPrivilege.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/property_and_function_privilege/__snapshots__/propertyAndFunctionPrivilege.spec.ts.snap @@ -227,13 +227,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ no_privilege_property: number; /** * @remarks - * @restricted-execution-read-only This property can't be edited in restricted-execution mode. + * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ none_privileged_property: number; @@ -241,7 +241,7 @@ export class ExampleClass { * @remarks * Test description * - * @restricted-execution-read-only This property can't be edited in restricted-execution mode. + * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ none_privileged_property_with_docs: number; @@ -249,21 +249,21 @@ export class ExampleClass { readonly read_only_property: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * - * @early-execution-allowed This function can be called in early-execution mode. + * @privelege early-execution-allowed. This function can be called in early-execution mode. * */ early_privileged_function(): boolean; /** * @remarks - * @early-execution-allowed This function can be called in early-execution mode. + * @privelege early-execution-allowed. This function can be called in early-execution mode. * */ multi_privileged_function(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ non_privileged_function(): boolean; @@ -271,7 +271,7 @@ export class ExampleClass { * @remarks * Test description * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ non_privileged_function_with_comments(): boolean; @@ -280,21 +280,21 @@ export class ExampleClass { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * - * @early-execution-allowed This function can be called in early-execution mode. + * @privelege early-execution-allowed. This function can be called in early-execution mode. * */ export function early_privileged_function(): boolean; /** * @remarks - * @early-execution-allowed This function can be called in early-execution mode. + * @privelege early-execution-allowed. This function can be called in early-execution mode. * */ export function multi_privileged_function(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function non_privileged_function(): boolean; @@ -302,7 +302,7 @@ export function non_privileged_function(): boolean; * @remarks * Test description * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function non_privileged_function_with_comments(): boolean; @@ -1536,70 +1536,70 @@ export class ExampleClass { private constructor(); /** * @remarks - * @early-execution-usable This property can be used in early-execution mode. + * @privelege early-execution-usable. This property can be used in early-execution mode. * */ prop_both_privileges: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * - * @early-execution-usable This property can be used in early-execution mode. + * @privelege early-execution-usable. This property can be used in early-execution mode. * */ prop_earlyexe_privilege: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * - * @early-execution-readable This property can be read in early-execution mode. + * @privelege early-execution-readable. This property can be read in early-execution mode. * */ prop_getearlyexe_privileges: number; /** * @remarks - * @restricted-execution-read-only This property can't be edited in restricted-execution mode. + * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ prop_getreadonly_privileges: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ prop_none_privilege: number; prop_readonly_privilege: number; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * - * @early-execution-editable This property can be edited in early-execution mode. + * @privelege early-execution-editable. This property can be edited in early-execution mode. * */ prop_setearlyexe_privileges: number; /** * @remarks - * @restricted-execution-non-readable This property can't be read in restricted-execution mode. + * @privelege restricted-execution-non-readable. This property can't be read in restricted-execution mode. * */ prop_setreadonly_privileges: number; /** * @remarks - * @early-execution-allowed This function can be called in early-execution mode. + * @privelege early-execution-allowed. This function can be called in early-execution mode. * */ memberfn_both_privileges(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * - * @early-execution-allowed This function can be called in early-execution mode. + * @privelege early-execution-allowed. This function can be called in early-execution mode. * */ memberfn_earlyexe_privilege(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ memberfn_none_privilege(): boolean; @@ -1608,21 +1608,21 @@ export class ExampleClass { /** * @remarks - * @early-execution-allowed This function can be called in early-execution mode. + * @privelege early-execution-allowed. This function can be called in early-execution mode. * */ export function fn_both_privileges(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * - * @early-execution-allowed This function can be called in early-execution mode. + * @privelege early-execution-allowed. This function can be called in early-execution mode. * */ export function fn_earlyexe_privilege(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function fn_none_privilege(): boolean; @@ -1813,13 +1813,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ no_privilege_property: number; /** * @remarks - * @restricted-execution-read-only This property can't be edited in restricted-execution mode. + * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ none_privileged_property: number; @@ -1827,7 +1827,7 @@ export class ExampleClass { * @remarks * Test description * - * @restricted-execution-read-only This property can't be edited in restricted-execution mode. + * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ none_privileged_property_with_docs: number; @@ -1835,7 +1835,7 @@ export class ExampleClass { readonly read_only_property: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ non_privileged_function(): boolean; @@ -1843,7 +1843,7 @@ export class ExampleClass { * @remarks * Test description * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ non_privileged_function_with_comments(): boolean; @@ -1852,7 +1852,7 @@ export class ExampleClass { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function non_privileged_function(): boolean; @@ -1860,7 +1860,7 @@ export function non_privileged_function(): boolean; * @remarks * Test description * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function non_privileged_function_with_comments(): boolean; @@ -2101,42 +2101,42 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-read-only This property can't be edited in restricted-execution mode. + * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ both_none_name_prop: number; both_read_only_name_prop: number; /** * @remarks - * @restricted-execution-read-only This property can't be edited in restricted-execution mode. + * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ new_default_name_prop: number; new_restrict_name_prop: number; /** * @remarks - * @restricted-execution-read-only This property can't be edited in restricted-execution mode. + * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ old_none_name_prop: number; old_read_only_name_prop: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ both_none_name_func(): boolean; both_read_only_name_func(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ new_default_name_func(): boolean; new_restrict_name_func(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ old_none_name_func(): boolean; @@ -2145,21 +2145,21 @@ export class ExampleClass { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function both_none_name_func(): boolean; export function both_read_only_name_func(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function new_default_name_func(): boolean; export function new_restrict_name_func(): boolean; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function old_none_name_func(): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/record_of_optional_variants/__snapshots__/recordOfOptionalVariants.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/record_of_optional_variants/__snapshots__/recordOfOptionalVariants.spec.ts.snap index 8e785756..677d7597 100644 --- a/tools/api-docs-generator-test-snapshots/test/record_of_optional_variants/__snapshots__/recordOfOptionalVariants.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/record_of_optional_variants/__snapshots__/recordOfOptionalVariants.spec.ts.snap @@ -90,7 +90,7 @@ export class ClassWithRecordOfOptionalVariantsProperty { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ exampleMember?: Record; diff --git a/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap index e0934025..d070cea5 100644 --- a/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap @@ -248,7 +248,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -257,7 +257,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc diff --git a/tools/api-docs-generator-test-snapshots/test/skip_merging_with_parent/__snapshots__/skipMerging.test.ts.snap b/tools/api-docs-generator-test-snapshots/test/skip_merging_with_parent/__snapshots__/skipMerging.test.ts.snap index 56256323..8a36a0ca 100644 --- a/tools/api-docs-generator-test-snapshots/test/skip_merging_with_parent/__snapshots__/skipMerging.test.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/skip_merging_with_parent/__snapshots__/skipMerging.test.ts.snap @@ -26,7 +26,7 @@ exports[`Skip Merging With Parent > Properly skips merging if skip merging is se */ /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ChildFunction(): number; @@ -57,7 +57,7 @@ exports[`Skip Merging With Parent > Properly skips merging if skip merging is se */ /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ParentFunction(): number; diff --git a/tools/api-docs-generator-test-snapshots/test/skip_merging_without_parent/__snapshots__/skipMerging.test.ts.snap b/tools/api-docs-generator-test-snapshots/test/skip_merging_without_parent/__snapshots__/skipMerging.test.ts.snap index 7afb1111..ae28beff 100644 --- a/tools/api-docs-generator-test-snapshots/test/skip_merging_without_parent/__snapshots__/skipMerging.test.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/skip_merging_without_parent/__snapshots__/skipMerging.test.ts.snap @@ -26,7 +26,7 @@ exports[`Skip Merging Without Parent > Properly skips merging if skip merging is */ /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ChildFunction(): number; diff --git a/tools/api-docs-generator-test-snapshots/test/static_functions/__snapshots__/staticFunctions.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/static_functions/__snapshots__/staticFunctions.spec.ts.snap index 8e2dca13..6b6309df 100644 --- a/tools/api-docs-generator-test-snapshots/test/static_functions/__snapshots__/staticFunctions.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/static_functions/__snapshots__/staticFunctions.spec.ts.snap @@ -126,25 +126,25 @@ export class ClassWithStaticFunction { private constructor(); /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ bbbExampleMemberFunction(): string; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ dddExampleMemberFunction(): string; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ static aaaExampleStaticFunction(): string; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ static cccExampleStaticFunction(): string; diff --git a/tools/api-docs-generator-test-snapshots/test/type_linking/__snapshots__/typeLinking.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/type_linking/__snapshots__/typeLinking.spec.ts.snap index 3dce7fbf..c4eb9744 100644 --- a/tools/api-docs-generator-test-snapshots/test/type_linking/__snapshots__/typeLinking.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/type_linking/__snapshots__/typeLinking.spec.ts.snap @@ -868,13 +868,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -890,7 +890,7 @@ export interface ExampleInterface { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -960,13 +960,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -982,7 +982,7 @@ export interface ExampleInterface { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -1147,13 +1147,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -1169,7 +1169,7 @@ export interface ExampleInterface { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -2313,13 +2313,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2335,7 +2335,7 @@ export interface ExampleInterface { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -2405,13 +2405,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2427,7 +2427,7 @@ export interface ExampleInterface { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -2592,13 +2592,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2614,7 +2614,7 @@ export interface ExampleInterface { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -2668,13 +2668,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2690,7 +2690,7 @@ export interface ExampleInterface { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -2744,13 +2744,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2766,7 +2766,7 @@ export interface ExampleInterface { /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/variants/__snapshots__/variants.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/variants/__snapshots__/variants.spec.ts.snap index 49ad5644..ea28edb8 100644 --- a/tools/api-docs-generator-test-snapshots/test/variants/__snapshots__/variants.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/variants/__snapshots__/variants.spec.ts.snap @@ -127,13 +127,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ propertyFunctionThatReturnsVariant: (arg0: number) => number | string; /** * @remarks - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ propertyFunctionThatReturnsVariantWithClosureThatReturnsVariant: ( @@ -141,13 +141,13 @@ export class ExampleClass { ) => (arg0: number) => (number | string) | string; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ exampleMethod(arg1: (arg0: number) => (arg0: number) => (number | string) | string, arg2: number): void; /** * @remarks - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * */ methodWithVariantOfArrays(arrays: number[] | string[]): boolean; diff --git a/tools/markup-generators-plugin/templates/tsdef/function.mustache b/tools/markup-generators-plugin/templates/tsdef/function.mustache index caddd86f..368d296c 100644 --- a/tools/markup-generators-plugin/templates/tsdef/function.mustache +++ b/tools/markup-generators-plugin/templates/tsdef/function.mustache @@ -24,11 +24,11 @@ * {{/function_description_ts.length}} {{#call_disallowed_in_restricted_execution}} - * @no-restricted-execution This function can't be called in restricted-execution mode. + * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. * {{/call_disallowed_in_restricted_execution}} {{#call_allowed_in_early_execution}} - * @early-execution-allowed This function can be called in early-execution mode. + * @privelege early-execution-allowed. This function can be called in early-execution mode. * {{/call_allowed_in_early_execution}} {{/ts_has_remarks}} @@ -42,7 +42,6 @@ {{/argument_description_ts.length}} {{#has_closure_privilege_type_comments}} * This closure is called with {{closure_privilege_type_name}} privilege. - * {{{name}}} @{{closure_privilege_type_name}}-closure {{/has_closure_privilege_type_comments}} {{#has_defaults}} {{#details.default_value}} @@ -69,14 +68,12 @@ {{/returns_description_ts}} {{#return_type_has_closure_privilege_type_comments}} * Closure that is called with {{return_type_closure_privilege_type_name}} privilege. - * {{{name}}} @{{return_type_closure_privilege_type_name}}-closure {{/return_type_has_closure_privilege_type_comments}} {{/returns_description_ts.length}} {{^returns_description_ts.length}} {{#return_type_has_closure_privilege_type_comments}} * @returns * Closure that is called with {{return_type_closure_privilege_type_name}} privilege. - * {{{name}}} @{{return_type_closure_privilege_type_name}}-closure {{/return_type_has_closure_privilege_type_comments}} {{/returns_description_ts.length}} {{#has_runtime_conditions}} diff --git a/tools/markup-generators-plugin/templates/tsdef/property.mustache b/tools/markup-generators-plugin/templates/tsdef/property.mustache index 03c3d0fd..9d2b2e37 100644 --- a/tools/markup-generators-plugin/templates/tsdef/property.mustache +++ b/tools/markup-generators-plugin/templates/tsdef/property.mustache @@ -25,38 +25,37 @@ {{/property_description_ts.length}} {{#has_closure_privilege_type_comments}} * This closure is called with {{closure_privilege_type_name}} privilege. - * {{property_name}} @{{closure_privilege_type_name}}-closure * {{/has_closure_privilege_type_comments}} {{#set_disallowed_in_restricted_execution}} {{#get_disallowed_in_restricted_execution}} - * @restricted-execution-unusable This property can't be used in restricted-execution mode. + * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. * {{/get_disallowed_in_restricted_execution}} {{^get_disallowed_in_restricted_execution}} - * @restricted-execution-read-only This property can't be edited in restricted-execution mode. + * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * {{/get_disallowed_in_restricted_execution}} {{/set_disallowed_in_restricted_execution}} {{^set_disallowed_in_restricted_execution}} {{#get_disallowed_in_restricted_execution}} - * @restricted-execution-non-readable This property can't be read in restricted-execution mode. + * @privelege restricted-execution-non-readable. This property can't be read in restricted-execution mode. * {{/get_disallowed_in_restricted_execution}} {{/set_disallowed_in_restricted_execution}} {{#set_allowed_in_early_execution}} {{#get_allowed_in_early_execution}} - * @early-execution-usable This property can be used in early-execution mode. + * @privelege early-execution-usable. This property can be used in early-execution mode. * {{/get_allowed_in_early_execution}} {{^get_allowed_in_early_execution}} - * @early-execution-editable This property can be edited in early-execution mode. + * @privelege early-execution-editable. This property can be edited in early-execution mode. * {{/get_allowed_in_early_execution}} {{/set_allowed_in_early_execution}} {{^set_allowed_in_early_execution}} {{#get_allowed_in_early_execution}} - * @early-execution-readable This property can be read in early-execution mode. + * @privelege early-execution-readable. This property can be read in early-execution mode. * {{/get_allowed_in_early_execution}} {{/set_allowed_in_early_execution}} From ff9ee94c963b7e887bf9f66eafa22e1b59288ddf Mon Sep 17 00:00:00 2001 From: Brandon Chan Date: Mon, 13 Jul 2026 17:11:51 -0700 Subject: [PATCH 4/4] Fix Spelling --- .../additiveBetaChange.spec.ts.snap | 4 +- .../arrayOfOptionalVariants.spec.ts.snap | 2 +- .../arrayOfVariants.spec.ts.snap | 2 +- .../bounds/__snapshots__/bounds.spec.ts.snap | 40 ++--- .../changelogDiffing.spec.ts.snap | 142 +++++++++--------- .../__snapshots__/closures.spec.ts.snap | 4 +- .../__snapshots__/data_buffer.spec.ts.snap | 20 +-- .../deprecationWarning.spec.ts.snap | 32 ++-- .../errors/__snapshots__/errors.spec.ts.snap | 28 ++-- .../__snapshots__/escapedNames.spec.ts.snap | 10 +- .../__snapshots__/general.spec.ts.snap | 30 ++-- .../hybrid_script_native_module.spec.ts.snap | 32 ++-- .../__snapshots__/iterator.spec.ts.snap | 4 +- .../test/maps/__snapshots__/maps.spec.ts.snap | 6 +- .../__snapshots__/optionals.spec.ts.snap | 10 +- .../prereleaseWarning.spec.ts.snap | 6 +- .../propertyAndFunctionPrivilege.spec.ts.snap | 94 ++++++------ .../recordOfOptionalVariants.spec.ts.snap | 2 +- .../script_generated_module.spec.ts.snap | 4 +- .../__snapshots__/skipMerging.test.ts.snap | 4 +- .../__snapshots__/skipMerging.test.ts.snap | 2 +- .../staticFunctions.spec.ts.snap | 8 +- .../__snapshots__/typeLinking.spec.ts.snap | 74 ++++----- .../__snapshots__/variants.spec.ts.snap | 8 +- .../templates/tsdef/function.mustache | 4 +- .../templates/tsdef/property.mustache | 12 +- 26 files changed, 295 insertions(+), 289 deletions(-) diff --git a/tools/api-docs-generator-test-snapshots/test/additive_beta_change/__snapshots__/additiveBetaChange.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/additive_beta_change/__snapshots__/additiveBetaChange.spec.ts.snap index 5cad6a83..ad312421 100644 --- a/tools/api-docs-generator-test-snapshots/test/additive_beta_change/__snapshots__/additiveBetaChange.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/additive_beta_change/__snapshots__/additiveBetaChange.spec.ts.snap @@ -187,7 +187,7 @@ export class ExampleClass1 { private constructor(); /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithAddedArgument(): boolean; @@ -226,7 +226,7 @@ export class ExampleClass1 { private constructor(); /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithAddedArgument(addedArg?: number): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/array_of_optional_variants/__snapshots__/arrayOfOptionalVariants.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/array_of_optional_variants/__snapshots__/arrayOfOptionalVariants.spec.ts.snap index f8deb5e6..a2b60861 100644 --- a/tools/api-docs-generator-test-snapshots/test/array_of_optional_variants/__snapshots__/arrayOfOptionalVariants.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/array_of_optional_variants/__snapshots__/arrayOfOptionalVariants.spec.ts.snap @@ -90,7 +90,7 @@ export class ClassWithArrayOfVariantsProperty { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ exampleMember?: (boolean | number | string | undefined)[]; diff --git a/tools/api-docs-generator-test-snapshots/test/array_of_variants/__snapshots__/arrayOfVariants.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/array_of_variants/__snapshots__/arrayOfVariants.spec.ts.snap index 7ebdd79f..ec294705 100644 --- a/tools/api-docs-generator-test-snapshots/test/array_of_variants/__snapshots__/arrayOfVariants.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/array_of_variants/__snapshots__/arrayOfVariants.spec.ts.snap @@ -90,7 +90,7 @@ export class ClassWithArrayOfVariantsProperty { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ exampleMember?: (boolean | string)[]; diff --git a/tools/api-docs-generator-test-snapshots/test/bounds/__snapshots__/bounds.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/bounds/__snapshots__/bounds.spec.ts.snap index 55db474b..54c83db0 100644 --- a/tools/api-docs-generator-test-snapshots/test/bounds/__snapshots__/bounds.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/bounds/__snapshots__/bounds.spec.ts.snap @@ -479,68 +479,68 @@ export class ClassWithBounds { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Bounds: [0, 0] */ r: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Minimum Value: -255 */ s: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Maximum Value: 1 */ t: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ u: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Bounds: [-255, -1] */ v: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ w: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Minimum Value: 1 */ x: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Maximum Value: 255 */ y: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Bounds: [1, 255] */ z: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param s * Minimum value: -255 @@ -602,68 +602,68 @@ export class ClassWithBounds { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Bounds: [0, 0] */ r: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Minimum Value: 1 */ s: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Maximum Value: 255 */ t: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ u: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Bounds: [1, 255] */ v: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Bounds: [1, 255] */ w: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Maximum Value: 255 */ x: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * Minimum Value: 1 */ y: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ z: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param s * Minimum value: 1 diff --git a/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap index e4637bde..cf85a7e5 100644 --- a/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/changelog_diffing/__snapshots__/changelogDiffing.spec.ts.snap @@ -4079,7 +4079,7 @@ export class ClassWithCrossModuleProperty { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ exampleProperty: testmodule1.SmallClass; @@ -4117,7 +4117,7 @@ export class ClassWithCrossModuleProperty { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ exampleProperty: testmodule1.SmallClass; @@ -4155,7 +4155,7 @@ export class ClassWithCrossModuleProperty { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ exampleProperty: testmodule1.SmallClass; @@ -4250,25 +4250,25 @@ export class ClassWithAddedBaseClass { export class ClassWithConstructor { /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ x: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ y: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ z: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ constructor(x: number, y: number, z: number); @@ -4283,13 +4283,13 @@ export class EntityIterator implements Iterable { private constructor(); /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ [Symbol.iterator](): Iterator; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ next(): IteratorResult; @@ -4299,43 +4299,43 @@ export class ExampleClass1 { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ boolProperty: boolean; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ floatProperty: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int16Property: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int32Property: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int64Property: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int8Property: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4343,13 +4343,13 @@ export class ExampleClass1 { readonly propertyWithReadOnlyChanging: string; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ stringProperty: string; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4357,68 +4357,68 @@ export class ExampleClass1 { readonly stringPropertyReadOnly: string; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint16Property: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint32Property: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint64Property: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint8Property: number; static readonly ClassConstantExample = 1337; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethod(stringArgument: string, stringArgumentOptional?: string): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithAddedArgument(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithAddedErrorable(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithChangedArgumentType(arg: string): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithChangedReturnType(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithRemovedArgument(removedArg: string): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ @@ -4429,7 +4429,7 @@ export class SmallClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4452,31 +4452,31 @@ export interface RemovedInterface { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithAddedArgument(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithAddedErrorable(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithChangedArgumentType(arg: string): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithRemovedArgument(removedArg: string): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ @@ -4554,37 +4554,37 @@ export class ClassWithAddedBaseClass extends SmallClass { export class ClassWithConstructor { /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ w: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ x: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ y: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ z: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ constructor(x: number, y: number, z: number); /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testFunction(argument1: string, argument2: string): number; @@ -4598,13 +4598,13 @@ export class EntityIterator implements Iterable { private constructor(); /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ [Symbol.iterator](): Iterator; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ next(): IteratorResult; @@ -4614,62 +4614,62 @@ export class ExampleClass1 { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ boolProperty: boolean; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ floatProperty: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int16Property: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int32Property: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int64Property: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int8Property: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ propertyWithChangedType: boolean; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ propertyWithReadOnlyChanging: string; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ stringProperty: string; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4677,69 +4677,69 @@ export class ExampleClass1 { readonly stringPropertyReadOnly: string; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint16Property: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint32Property: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint64Property: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint8Property: number; static readonly ClassConstantExample = 1338; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethod(stringArgument: string, stringArgumentOptional?: string): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithAddedArgument(addedArg: string): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ testMethodWithAddedErrorable(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithChangedArgumentType(arg: number): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithChangedReturnType(): string; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithRemovedArgument(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ testMethodWithRemovedErrorable(): boolean; @@ -4749,7 +4749,7 @@ export class SmallClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ @@ -4766,38 +4766,38 @@ export interface ExampleInterface { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithAddedArgument(addedArg: string): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ export function testFunctionWithAddedErrorable(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithChangedArgumentType(arg: number): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithRemovedArgument(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testFunctionWithRemovedErrorable(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function testGlobalFunction(argument1: string): number; diff --git a/tools/api-docs-generator-test-snapshots/test/closures/__snapshots__/closures.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/closures/__snapshots__/closures.spec.ts.snap index abfbe29e..934b4972 100644 --- a/tools/api-docs-generator-test-snapshots/test/closures/__snapshots__/closures.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/closures/__snapshots__/closures.spec.ts.snap @@ -235,9 +235,9 @@ export class ExampleClass { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * - * @privelege early-execution-allowed. This function can be called in early-execution mode. + * @privilege early-execution-allowed. This function can be called in early-execution mode. * * @param closureRestrictedExec * This closure is called with restricted-execution privilege. diff --git a/tools/api-docs-generator-test-snapshots/test/data_buffer/__snapshots__/data_buffer.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/data_buffer/__snapshots__/data_buffer.spec.ts.snap index af8640d3..0651ffc3 100644 --- a/tools/api-docs-generator-test-snapshots/test/data_buffer/__snapshots__/data_buffer.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/data_buffer/__snapshots__/data_buffer.spec.ts.snap @@ -162,61 +162,61 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ doubleDataBufferProperty: Float64Array; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ floatDataBufferProperty: Float32Array; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int16DataBufferProperty: Int16Array; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int32DataBufferProperty: Int32Array; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int64DataBufferProperty: BigInt64Array; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ int8DataBufferProperty: Uint8Array; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint16DataBufferProperty: Uint16Array; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint32DataBufferProperty: Uint32Array; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint64DataBufferProperty: BigUint64Array; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ uint8DataBufferProperty: Uint8Array; diff --git a/tools/api-docs-generator-test-snapshots/test/deprecation_warning/__snapshots__/deprecationWarning.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/deprecation_warning/__snapshots__/deprecationWarning.spec.ts.snap index 56e927eb..4f5ae6f7 100644 --- a/tools/api-docs-generator-test-snapshots/test/deprecation_warning/__snapshots__/deprecationWarning.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/deprecation_warning/__snapshots__/deprecationWarning.spec.ts.snap @@ -681,13 +681,13 @@ export class StableClassWithDeprecatedMembers { * @deprecated This property is deprecated and will be removed in 2.0.0. * * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ deprecatedProperty: boolean; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ stableProperty: boolean; @@ -700,13 +700,13 @@ export class StableClassWithDeprecatedMembers { * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ deprecatedFunction(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ stableFunction(): boolean; @@ -748,7 +748,7 @@ export class StableErrorWithDeprecatedProperty extends Error { * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function deprecatedGlobalFunction(): boolean; @@ -756,7 +756,7 @@ export function deprecatedGlobalFunction(): boolean; * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function stableGlobalFunction(): boolean; @@ -824,13 +824,13 @@ export class StableClassWithDeprecatedMembers { * @deprecated This property is deprecated and will be removed in 2.0.0. * * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ deprecatedProperty: boolean; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ stableProperty: boolean; @@ -843,13 +843,13 @@ export class StableClassWithDeprecatedMembers { * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ deprecatedFunction(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ stableFunction(): boolean; @@ -890,7 +890,7 @@ export class StableErrorWithDeprecatedProperty extends Error { /** * @beta * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function betaGlobalFunctionNotInAlpha(): boolean; @@ -898,7 +898,7 @@ export function betaGlobalFunctionNotInAlpha(): boolean; * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function deprecatedGlobalFunction(): boolean; @@ -906,7 +906,7 @@ export function deprecatedGlobalFunction(): boolean; * @deprecated This function is deprecated and will be removed in 2.0.0. * * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function stableGlobalFunction(): boolean; @@ -948,14 +948,14 @@ export class StableClassWithDeprecatedMembers { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ stableProperty: boolean; static readonly stableConstant: boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ stableFunction(): boolean; @@ -974,7 +974,7 @@ export class StableErrorWithDeprecatedProperty extends Error { /** * @alpha * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function v2GlobalFunction(): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/errors/__snapshots__/errors.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/errors/__snapshots__/errors.spec.ts.snap index 67f6d2fe..e3f8bf58 100644 --- a/tools/api-docs-generator-test-snapshots/test/errors/__snapshots__/errors.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/errors/__snapshots__/errors.spec.ts.snap @@ -429,14 +429,14 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. */ examplePropertyThatThrows: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. * @@ -445,7 +445,7 @@ export class ExampleClass { examplePropertyThatThrowsCustomError: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. * @@ -462,7 +462,7 @@ export class ExampleClass { examplePropertyThatThrowsWithReadOnlyPrivilege: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. * @@ -471,7 +471,7 @@ export class ExampleClass { examplePropertyWithCrossModuleError: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * * @throws This property can throw when used. * @@ -480,20 +480,20 @@ export class ExampleClass { examplePropertyWithCrossModuleReturnAndError: minecraftexamplemodule2.CrossModuleReturn; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ exampleMethodThatTakesErrorParam(errorParam: unknown): string; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ exampleMethodThatThrows(): string; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -502,7 +502,7 @@ export class ExampleClass { exampleMethodThatThrowsCustomError(): string; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -539,14 +539,14 @@ export class ExampleError2 extends Error { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. */ export function exampleFunctionThatThrows(): string; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -555,7 +555,7 @@ export function exampleFunctionThatThrows(): string; export function exampleFunctionThatThrowsCustomError(): string; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -566,7 +566,7 @@ export function exampleFunctionThatThrowsCustomError(): string; export function exampleFunctionThatThrowsTwoErrors(): string; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * @@ -575,7 +575,7 @@ export function exampleFunctionThatThrowsTwoErrors(): string; export function exampleFunctionWithCrossModuleError(): number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @throws This function can throw errors. * diff --git a/tools/api-docs-generator-test-snapshots/test/escaped_names/__snapshots__/escapedNames.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/escaped_names/__snapshots__/escapedNames.spec.ts.snap index 681f4006..0ecd057c 100644 --- a/tools/api-docs-generator-test-snapshots/test/escaped_names/__snapshots__/escapedNames.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/escaped_names/__snapshots__/escapedNames.spec.ts.snap @@ -242,31 +242,31 @@ export class ClassWithSpookyMemberNames { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ '5memberWithNumberStart': number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ 'member with spaces': number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ 'type': number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ 'void': number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ delete(): void; diff --git a/tools/api-docs-generator-test-snapshots/test/general/__snapshots__/general.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/general/__snapshots__/general.spec.ts.snap index 7843131a..f3a5808a 100644 --- a/tools/api-docs-generator-test-snapshots/test/general/__snapshots__/general.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/general/__snapshots__/general.spec.ts.snap @@ -552,7 +552,7 @@ exports[`General > Properly generates documentation for the input > npm/types/te export class ClassWithEmptyConstructor { /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ numberProperty: number; @@ -562,14 +562,14 @@ export class ClassWithEmptyConstructor { export class ClassWithExplicitConstructor { /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ numberProperty: number; readonly readOnlyNumberProperty: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ constructor(constructorArg: string); @@ -579,7 +579,7 @@ export class ClassWithOptionalProperty { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ numberProperty: number; @@ -595,7 +595,7 @@ export interface ExampleInterface { * @remarks * This is a test function * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @example sharedExample.ts * \`\`\`typescript @@ -2320,7 +2320,7 @@ exports[`General > Properly generates documentation for the input > typedoc/clas

Constructors

constructor

Properties

numberProperty readOnlyNumberProperty -

Constructors

constructor

Properties

numberProperty

numberProperty: number

Remarks

Privelege

restricted-execution-unusable. This property can't be used in restricted-execution mode.

+

Constructors

constructor

Properties

numberProperty

numberProperty: number

Remarks

Privilege

restricted-execution-unusable. This property can't be used in restricted-execution mode.

ReadonlyreadOnlyNumberProperty

readOnlyNumberProperty: number

Settings

Member Visibility

On This Page

Constructors
Properties
" `; @@ -2329,8 +2329,8 @@ exports[`General > Properly generates documentation for the input > typedoc/clas "ClassWithExplicitConstructor | Minecraft

Class ClassWithExplicitConstructor

Constructors

constructor

Properties

numberProperty readOnlyNumberProperty -

Constructors

constructor

Properties

numberProperty

numberProperty: number

Remarks

Privelege

restricted-execution-unusable. This property can't be used in restricted-execution mode.

+

Constructors

constructor

Properties

numberProperty

numberProperty: number

Remarks

Privilege

restricted-execution-unusable. This property can't be used in restricted-execution mode.

ReadonlyreadOnlyNumberProperty

readOnlyNumberProperty: number

Settings

Member Visibility

On This Page

Constructors
Properties
" `; @@ -2338,14 +2338,14 @@ exports[`General > Properly generates documentation for the input > typedoc/clas exports[`General > Properly generates documentation for the input > typedoc/classes/ClassWithOptionalProperty.html 1`] = ` "ClassWithOptionalProperty | Minecraft

Class ClassWithOptionalProperty

Properties

numberProperty optionalNumberProperty? -

Properties

numberProperty

numberProperty: number

Remarks

Privelege

restricted-execution-unusable. This property can't be used in restricted-execution mode.

+

Properties

numberProperty

numberProperty: number

Remarks

Privilege

restricted-execution-unusable. This property can't be used in restricted-execution mode.

Optional ReadonlyoptionalNumberProperty

optionalNumberProperty?: number

Settings

Member Visibility

On This Page

Properties
" `; exports[`General > Properly generates documentation for the input > typedoc/functions/ModuleFunction.html 1`] = ` "ModuleFunction | Minecraft

Function ModuleFunction

  • ModuleFunction(): ClassWithConstructor

  • Returns ClassWithConstructor

    Remarks

    This is a test function

    -

    Privelege

    no-restricted-execution. This function can't be called in restricted-execution mode.

    +

    Privilege

    no-restricted-execution. This function can't be called in restricted-execution mode.

    Example: sharedExample.ts

    let sharedExample = true;

    /\\* This is a sample that also declares a function and has braces */
    function testFunction() {}
    @@ -2417,7 +2417,7 @@ exports[`General > Properly generates documentation for the input > typescript/t export class ClassWithEmptyConstructor { /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ numberProperty: number; @@ -2427,14 +2427,14 @@ export class ClassWithEmptyConstructor { export class ClassWithExplicitConstructor { /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ numberProperty: number; readonly readOnlyNumberProperty: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ constructor(constructorArg: string); @@ -2444,7 +2444,7 @@ export class ClassWithOptionalProperty { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ numberProperty: number; @@ -2460,7 +2460,7 @@ export interface ExampleInterface { * @remarks * This is a test function * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @example sharedExample.ts * \`\`\`typescript diff --git a/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap index 54741af0..dce6b6ce 100644 --- a/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/hybrid_script_native_module/__snapshots__/hybrid_script_native_module.spec.ts.snap @@ -564,7 +564,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -573,7 +573,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -683,7 +683,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -692,7 +692,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -1054,7 +1054,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -1063,7 +1063,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -1144,7 +1144,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -1153,7 +1153,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -1802,7 +1802,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -1811,7 +1811,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -1921,7 +1921,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -1930,7 +1930,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -2123,7 +2123,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -2132,7 +2132,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc @@ -2213,7 +2213,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -2222,7 +2222,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc diff --git a/tools/api-docs-generator-test-snapshots/test/iterator/__snapshots__/iterator.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/iterator/__snapshots__/iterator.spec.ts.snap index 10fe36ca..3ffcf7c8 100644 --- a/tools/api-docs-generator-test-snapshots/test/iterator/__snapshots__/iterator.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/iterator/__snapshots__/iterator.spec.ts.snap @@ -107,13 +107,13 @@ export class ExampleIterator implements Iterable { private constructor(); /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ [Symbol.iterator](): Iterator; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ next(): IteratorResult; diff --git a/tools/api-docs-generator-test-snapshots/test/maps/__snapshots__/maps.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/maps/__snapshots__/maps.spec.ts.snap index a5eee16b..34f75133 100644 --- a/tools/api-docs-generator-test-snapshots/test/maps/__snapshots__/maps.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/maps/__snapshots__/maps.spec.ts.snap @@ -115,19 +115,19 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ mapProperty: Record; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ exampleMethodReturnsMap(): Record; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ exampleMethodTakesMapArg(arg: Record): void; diff --git a/tools/api-docs-generator-test-snapshots/test/optionals/__snapshots__/optionals.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/optionals/__snapshots__/optionals.spec.ts.snap index af8b674d..abc2c5d5 100644 --- a/tools/api-docs-generator-test-snapshots/test/optionals/__snapshots__/optionals.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/optionals/__snapshots__/optionals.spec.ts.snap @@ -237,31 +237,31 @@ export class ClassWithOptionals { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ optionalProperty?: boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ methodThatReturnsOptional(): boolean | undefined; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ methodThatTakesOptionals(arg1?: boolean, arg2?: string): void; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ methodThatTakesRecordOfOptionalVariants(values: Record): void; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param defaultIs1 * Defaults to: 1 diff --git a/tools/api-docs-generator-test-snapshots/test/prerelease_warning/__snapshots__/prereleaseWarning.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/prerelease_warning/__snapshots__/prereleaseWarning.spec.ts.snap index 05b9008f..4b28a1e7 100644 --- a/tools/api-docs-generator-test-snapshots/test/prerelease_warning/__snapshots__/prereleaseWarning.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/prerelease_warning/__snapshots__/prereleaseWarning.spec.ts.snap @@ -570,14 +570,14 @@ export class StableClass { /** * @beta * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ prereleaseProperty: number; /** * @beta * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ prereleaseMethod(): number; @@ -598,7 +598,7 @@ export interface StableInterface { /** * @beta * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function prereleaseFunction(): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/property_and_function_privilege/__snapshots__/propertyAndFunctionPrivilege.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/property_and_function_privilege/__snapshots__/propertyAndFunctionPrivilege.spec.ts.snap index fefbbf97..89bbd5ef 100644 --- a/tools/api-docs-generator-test-snapshots/test/property_and_function_privilege/__snapshots__/propertyAndFunctionPrivilege.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/property_and_function_privilege/__snapshots__/propertyAndFunctionPrivilege.spec.ts.snap @@ -227,13 +227,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ no_privilege_property: number; /** * @remarks - * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. + * @privilege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ none_privileged_property: number; @@ -241,7 +241,7 @@ export class ExampleClass { * @remarks * Test description * - * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. + * @privilege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ none_privileged_property_with_docs: number; @@ -249,21 +249,21 @@ export class ExampleClass { readonly read_only_property: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * - * @privelege early-execution-allowed. This function can be called in early-execution mode. + * @privilege early-execution-allowed. This function can be called in early-execution mode. * */ early_privileged_function(): boolean; /** * @remarks - * @privelege early-execution-allowed. This function can be called in early-execution mode. + * @privilege early-execution-allowed. This function can be called in early-execution mode. * */ multi_privileged_function(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ non_privileged_function(): boolean; @@ -271,7 +271,7 @@ export class ExampleClass { * @remarks * Test description * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ non_privileged_function_with_comments(): boolean; @@ -280,21 +280,21 @@ export class ExampleClass { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * - * @privelege early-execution-allowed. This function can be called in early-execution mode. + * @privilege early-execution-allowed. This function can be called in early-execution mode. * */ export function early_privileged_function(): boolean; /** * @remarks - * @privelege early-execution-allowed. This function can be called in early-execution mode. + * @privilege early-execution-allowed. This function can be called in early-execution mode. * */ export function multi_privileged_function(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function non_privileged_function(): boolean; @@ -302,7 +302,7 @@ export function non_privileged_function(): boolean; * @remarks * Test description * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function non_privileged_function_with_comments(): boolean; @@ -1536,70 +1536,70 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege early-execution-usable. This property can be used in early-execution mode. + * @privilege early-execution-usable. This property can be used in early-execution mode. * */ prop_both_privileges: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * - * @privelege early-execution-usable. This property can be used in early-execution mode. + * @privilege early-execution-usable. This property can be used in early-execution mode. * */ prop_earlyexe_privilege: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * - * @privelege early-execution-readable. This property can be read in early-execution mode. + * @privilege early-execution-readable. This property can be read in early-execution mode. * */ prop_getearlyexe_privileges: number; /** * @remarks - * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. + * @privilege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ prop_getreadonly_privileges: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ prop_none_privilege: number; prop_readonly_privilege: number; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * - * @privelege early-execution-editable. This property can be edited in early-execution mode. + * @privilege early-execution-editable. This property can be edited in early-execution mode. * */ prop_setearlyexe_privileges: number; /** * @remarks - * @privelege restricted-execution-non-readable. This property can't be read in restricted-execution mode. + * @privilege restricted-execution-non-readable. This property can't be read in restricted-execution mode. * */ prop_setreadonly_privileges: number; /** * @remarks - * @privelege early-execution-allowed. This function can be called in early-execution mode. + * @privilege early-execution-allowed. This function can be called in early-execution mode. * */ memberfn_both_privileges(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * - * @privelege early-execution-allowed. This function can be called in early-execution mode. + * @privilege early-execution-allowed. This function can be called in early-execution mode. * */ memberfn_earlyexe_privilege(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ memberfn_none_privilege(): boolean; @@ -1608,21 +1608,21 @@ export class ExampleClass { /** * @remarks - * @privelege early-execution-allowed. This function can be called in early-execution mode. + * @privilege early-execution-allowed. This function can be called in early-execution mode. * */ export function fn_both_privileges(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * - * @privelege early-execution-allowed. This function can be called in early-execution mode. + * @privilege early-execution-allowed. This function can be called in early-execution mode. * */ export function fn_earlyexe_privilege(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function fn_none_privilege(): boolean; @@ -1813,13 +1813,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ no_privilege_property: number; /** * @remarks - * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. + * @privilege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ none_privileged_property: number; @@ -1827,7 +1827,7 @@ export class ExampleClass { * @remarks * Test description * - * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. + * @privilege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ none_privileged_property_with_docs: number; @@ -1835,7 +1835,7 @@ export class ExampleClass { readonly read_only_property: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ non_privileged_function(): boolean; @@ -1843,7 +1843,7 @@ export class ExampleClass { * @remarks * Test description * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ non_privileged_function_with_comments(): boolean; @@ -1852,7 +1852,7 @@ export class ExampleClass { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function non_privileged_function(): boolean; @@ -1860,7 +1860,7 @@ export function non_privileged_function(): boolean; * @remarks * Test description * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function non_privileged_function_with_comments(): boolean; @@ -2101,42 +2101,42 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. + * @privilege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ both_none_name_prop: number; both_read_only_name_prop: number; /** * @remarks - * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. + * @privilege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ new_default_name_prop: number; new_restrict_name_prop: number; /** * @remarks - * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. + * @privilege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * */ old_none_name_prop: number; old_read_only_name_prop: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ both_none_name_func(): boolean; both_read_only_name_func(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ new_default_name_func(): boolean; new_restrict_name_func(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ old_none_name_func(): boolean; @@ -2145,21 +2145,21 @@ export class ExampleClass { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function both_none_name_func(): boolean; export function both_read_only_name_func(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function new_default_name_func(): boolean; export function new_restrict_name_func(): boolean; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function old_none_name_func(): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/record_of_optional_variants/__snapshots__/recordOfOptionalVariants.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/record_of_optional_variants/__snapshots__/recordOfOptionalVariants.spec.ts.snap index 677d7597..e3ad37dd 100644 --- a/tools/api-docs-generator-test-snapshots/test/record_of_optional_variants/__snapshots__/recordOfOptionalVariants.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/record_of_optional_variants/__snapshots__/recordOfOptionalVariants.spec.ts.snap @@ -90,7 +90,7 @@ export class ClassWithRecordOfOptionalVariantsProperty { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ exampleMember?: Record; diff --git a/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap index d070cea5..92d31130 100644 --- a/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/script_generated_module/__snapshots__/script_generated_module.spec.ts.snap @@ -248,7 +248,7 @@ export declare class ScriptGeneratedClass { * @remarks * A script generated property * - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ testProperty: string | undefined; @@ -257,7 +257,7 @@ export declare class ScriptGeneratedClass { * A script generated function with doc text defined in TSDoc * comments * - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * * @param tsdocParam * Param comment from TSDoc diff --git a/tools/api-docs-generator-test-snapshots/test/skip_merging_with_parent/__snapshots__/skipMerging.test.ts.snap b/tools/api-docs-generator-test-snapshots/test/skip_merging_with_parent/__snapshots__/skipMerging.test.ts.snap index 8a36a0ca..141bc708 100644 --- a/tools/api-docs-generator-test-snapshots/test/skip_merging_with_parent/__snapshots__/skipMerging.test.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/skip_merging_with_parent/__snapshots__/skipMerging.test.ts.snap @@ -26,7 +26,7 @@ exports[`Skip Merging With Parent > Properly skips merging if skip merging is se */ /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ChildFunction(): number; @@ -57,7 +57,7 @@ exports[`Skip Merging With Parent > Properly skips merging if skip merging is se */ /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ParentFunction(): number; diff --git a/tools/api-docs-generator-test-snapshots/test/skip_merging_without_parent/__snapshots__/skipMerging.test.ts.snap b/tools/api-docs-generator-test-snapshots/test/skip_merging_without_parent/__snapshots__/skipMerging.test.ts.snap index ae28beff..ee72caf9 100644 --- a/tools/api-docs-generator-test-snapshots/test/skip_merging_without_parent/__snapshots__/skipMerging.test.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/skip_merging_without_parent/__snapshots__/skipMerging.test.ts.snap @@ -26,7 +26,7 @@ exports[`Skip Merging Without Parent > Properly skips merging if skip merging is */ /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ChildFunction(): number; diff --git a/tools/api-docs-generator-test-snapshots/test/static_functions/__snapshots__/staticFunctions.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/static_functions/__snapshots__/staticFunctions.spec.ts.snap index 6b6309df..beeea738 100644 --- a/tools/api-docs-generator-test-snapshots/test/static_functions/__snapshots__/staticFunctions.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/static_functions/__snapshots__/staticFunctions.spec.ts.snap @@ -126,25 +126,25 @@ export class ClassWithStaticFunction { private constructor(); /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ bbbExampleMemberFunction(): string; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ dddExampleMemberFunction(): string; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ static aaaExampleStaticFunction(): string; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ static cccExampleStaticFunction(): string; diff --git a/tools/api-docs-generator-test-snapshots/test/type_linking/__snapshots__/typeLinking.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/type_linking/__snapshots__/typeLinking.spec.ts.snap index 88635c5f..09a47695 100644 --- a/tools/api-docs-generator-test-snapshots/test/type_linking/__snapshots__/typeLinking.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/type_linking/__snapshots__/typeLinking.spec.ts.snap @@ -343,7 +343,7 @@ Example enum: [*@minecraft/example-module.ExampleEnum*](../../../scriptapi/minec Example enum value: [*@minecraft/example-module.ExampleEnum.ExampleValue*](../../../scriptapi/minecraft/example-module/ExampleEnum.md#examplevalue) -Example error: [*@minecraft/example-module.ExampleError*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#exampleerror) +Example error: {@link @minecraft/example-module.ExampleError} This line has multiple links! [*@minecraft/example-module*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md) [*@minecraft/example-module.ExampleFunction*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#examplefunction) [*@minecraft/example-module.ExampleConstant*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#exampleconstant) [*@minecraft/example-module.ExampleObject*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#exampleobject) @@ -490,7 +490,7 @@ Example enum: [*@minecraft/example-module.ExampleEnum*](../../../scriptapi/minec Example enum value: [*@minecraft/example-module.ExampleEnum.ExampleValue*](../../../scriptapi/minecraft/example-module/ExampleEnum.md#examplevalue) -Example error: [*@minecraft/example-module.ExampleError*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#exampleerror) +Example error: {@link @minecraft/example-module.ExampleError} This line has multiple links and lots of text! This is the first link [*@minecraft/example-module*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md), and this is the second. [*@minecraft/example-module.ExampleFunction*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#examplefunction) Here's a third link [*@minecraft/example-module.ExampleConstant*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#exampleconstant) and this one here is the final link [*@minecraft/example-module.ExampleObject*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#exampleobject) @@ -876,7 +876,8 @@ exports[`Type Linking > Properly generates documentation for types that are link * {@link ExampleInterface.ExampleProperty} * Example enum: {@link ExampleEnum} * Example enum value: {@link ExampleEnum.ExampleValue} - * Example error: {@link ExampleError} + * Example error: + * {@link @minecraft/example-module.ExampleError} * This line has multiple links! * {@link @minecraft/example-module} {@link ExampleFunction} * {@link ExampleConstant} {@link ExampleObject} @@ -913,13 +914,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -940,7 +941,7 @@ export class ExampleError extends Error { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -974,7 +975,8 @@ exports[`Type Linking > Properly generates documentation for types that are link * {@link ExampleInterface.ExampleProperty} * Example enum: {@link ExampleEnum} * Example enum value: {@link ExampleEnum.ExampleValue} - * Example error: {@link ExampleError} + * Example error: + * {@link @minecraft/example-module.ExampleError} * This line has multiple links! * {@link @minecraft/example-module} {@link ExampleFunction} * {@link ExampleConstant} {@link ExampleObject} @@ -1011,13 +1013,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -1038,7 +1040,7 @@ export class ExampleError extends Error { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -1080,7 +1082,8 @@ exports[`Type Linking > Properly generates documentation for types that are link * Example enum: {@link minecraftexamplemodule.ExampleEnum} * Example enum value: * {@link minecraftexamplemodule.ExampleEnum.ExampleValue} - * Example error: {@link minecraftexamplemodule#ExampleError} + * Example error: + * {@link @minecraft/example-module.ExampleError} * This line has multiple links and lots of text! This is the * first link {@link minecraftexamplemodule}, and this is the * second. {@link minecraftexamplemodule#ExampleFunction} @@ -1204,13 +1207,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -1231,7 +1234,7 @@ export class ExampleError extends Error { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -1604,7 +1607,7 @@ Example enum: [*@minecraft/example-module.ExampleEnum*](../../../scriptapi/minec Example enum value: [*@minecraft/example-module.ExampleEnum.ExampleValue*](../../../scriptapi/minecraft/example-module/ExampleEnum.md#examplevalue) -Example error: [*@minecraft/example-module.ExampleError*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#exampleerror) +Example error: {@link @minecraft/example-module.ExampleError} This line has multiple links! [*@minecraft/example-module*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md) [*@minecraft/example-module.ExampleFunction*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#examplefunction) [*@minecraft/example-module.ExampleConstant*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#exampleconstant) [*@minecraft/example-module.ExampleObject*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#exampleobject) @@ -1751,7 +1754,7 @@ Example enum: [*@minecraft/example-module.ExampleEnum*](../../../scriptapi/minec Example enum value: [*@minecraft/example-module.ExampleEnum.ExampleValue*](../../../scriptapi/minecraft/example-module/ExampleEnum.md#examplevalue) -Example error: [*@minecraft/example-module.ExampleError*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#exampleerror) +Example error: {@link @minecraft/example-module.ExampleError} This line has multiple links and lots of text! This is the first link [*@minecraft/example-module*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md), and this is the second. [*@minecraft/example-module.ExampleFunction*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#examplefunction) Here's a third link [*@minecraft/example-module.ExampleConstant*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#exampleconstant) and this one here is the final link [*@minecraft/example-module.ExampleObject*](../../../scriptapi/minecraft/example-module/minecraft-example-module.md#exampleobject) @@ -2403,7 +2406,8 @@ exports[`Type Linking > Properly generates documentation for types that are link * {@link ExampleInterface.ExampleProperty} * Example enum: {@link ExampleEnum} * Example enum value: {@link ExampleEnum.ExampleValue} - * Example error: {@link ExampleError} + * Example error: + * {@link @minecraft/example-module.ExampleError} * This line has multiple links! * {@link @minecraft/example-module} {@link ExampleFunction} * {@link ExampleConstant} {@link ExampleObject} @@ -2440,13 +2444,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2467,7 +2471,7 @@ export class ExampleError extends Error { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -2501,7 +2505,8 @@ exports[`Type Linking > Properly generates documentation for types that are link * {@link ExampleInterface.ExampleProperty} * Example enum: {@link ExampleEnum} * Example enum value: {@link ExampleEnum.ExampleValue} - * Example error: {@link ExampleError} + * Example error: + * {@link @minecraft/example-module.ExampleError} * This line has multiple links! * {@link @minecraft/example-module} {@link ExampleFunction} * {@link ExampleConstant} {@link ExampleObject} @@ -2538,13 +2543,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2565,7 +2570,7 @@ export class ExampleError extends Error { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -2607,7 +2612,8 @@ exports[`Type Linking > Properly generates documentation for types that are link * Example enum: {@link minecraftexamplemodule.ExampleEnum} * Example enum value: * {@link minecraftexamplemodule.ExampleEnum.ExampleValue} - * Example error: {@link minecraftexamplemodule#ExampleError} + * Example error: + * {@link @minecraft/example-module.ExampleError} * This line has multiple links and lots of text! This is the * first link {@link minecraftexamplemodule}, and this is the * second. {@link minecraftexamplemodule#ExampleFunction} @@ -2731,13 +2737,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2758,7 +2764,7 @@ export class ExampleError extends Error { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -2812,13 +2818,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2839,7 +2845,7 @@ export class ExampleError extends Error { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; @@ -2893,13 +2899,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ ExampleProperty: number; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ ExampleMethod(testArg: string): boolean; @@ -2920,7 +2926,7 @@ export class ExampleError extends Error { /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ export function ExampleFunction(testArg: string): boolean; diff --git a/tools/api-docs-generator-test-snapshots/test/variants/__snapshots__/variants.spec.ts.snap b/tools/api-docs-generator-test-snapshots/test/variants/__snapshots__/variants.spec.ts.snap index ea28edb8..f70e35bf 100644 --- a/tools/api-docs-generator-test-snapshots/test/variants/__snapshots__/variants.spec.ts.snap +++ b/tools/api-docs-generator-test-snapshots/test/variants/__snapshots__/variants.spec.ts.snap @@ -127,13 +127,13 @@ export class ExampleClass { private constructor(); /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ propertyFunctionThatReturnsVariant: (arg0: number) => number | string; /** * @remarks - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * */ propertyFunctionThatReturnsVariantWithClosureThatReturnsVariant: ( @@ -141,13 +141,13 @@ export class ExampleClass { ) => (arg0: number) => (number | string) | string; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ exampleMethod(arg1: (arg0: number) => (arg0: number) => (number | string) | string, arg2: number): void; /** * @remarks - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * */ methodWithVariantOfArrays(arrays: number[] | string[]): boolean; diff --git a/tools/markup-generators-plugin/templates/tsdef/function.mustache b/tools/markup-generators-plugin/templates/tsdef/function.mustache index 368d296c..60a54b5a 100644 --- a/tools/markup-generators-plugin/templates/tsdef/function.mustache +++ b/tools/markup-generators-plugin/templates/tsdef/function.mustache @@ -24,11 +24,11 @@ * {{/function_description_ts.length}} {{#call_disallowed_in_restricted_execution}} - * @privelege no-restricted-execution. This function can't be called in restricted-execution mode. + * @privilege no-restricted-execution. This function can't be called in restricted-execution mode. * {{/call_disallowed_in_restricted_execution}} {{#call_allowed_in_early_execution}} - * @privelege early-execution-allowed. This function can be called in early-execution mode. + * @privilege early-execution-allowed. This function can be called in early-execution mode. * {{/call_allowed_in_early_execution}} {{/ts_has_remarks}} diff --git a/tools/markup-generators-plugin/templates/tsdef/property.mustache b/tools/markup-generators-plugin/templates/tsdef/property.mustache index 9d2b2e37..14134fa4 100644 --- a/tools/markup-generators-plugin/templates/tsdef/property.mustache +++ b/tools/markup-generators-plugin/templates/tsdef/property.mustache @@ -29,33 +29,33 @@ {{/has_closure_privilege_type_comments}} {{#set_disallowed_in_restricted_execution}} {{#get_disallowed_in_restricted_execution}} - * @privelege restricted-execution-unusable. This property can't be used in restricted-execution mode. + * @privilege restricted-execution-unusable. This property can't be used in restricted-execution mode. * {{/get_disallowed_in_restricted_execution}} {{^get_disallowed_in_restricted_execution}} - * @privelege restricted-execution-read-only. This property can't be edited in restricted-execution mode. + * @privilege restricted-execution-read-only. This property can't be edited in restricted-execution mode. * {{/get_disallowed_in_restricted_execution}} {{/set_disallowed_in_restricted_execution}} {{^set_disallowed_in_restricted_execution}} {{#get_disallowed_in_restricted_execution}} - * @privelege restricted-execution-non-readable. This property can't be read in restricted-execution mode. + * @privilege restricted-execution-non-readable. This property can't be read in restricted-execution mode. * {{/get_disallowed_in_restricted_execution}} {{/set_disallowed_in_restricted_execution}} {{#set_allowed_in_early_execution}} {{#get_allowed_in_early_execution}} - * @privelege early-execution-usable. This property can be used in early-execution mode. + * @privilege early-execution-usable. This property can be used in early-execution mode. * {{/get_allowed_in_early_execution}} {{^get_allowed_in_early_execution}} - * @privelege early-execution-editable. This property can be edited in early-execution mode. + * @privilege early-execution-editable. This property can be edited in early-execution mode. * {{/get_allowed_in_early_execution}} {{/set_allowed_in_early_execution}} {{^set_allowed_in_early_execution}} {{#get_allowed_in_early_execution}} - * @privelege early-execution-readable. This property can be read in early-execution mode. + * @privilege early-execution-readable. This property can be read in early-execution mode. * {{/get_allowed_in_early_execution}} {{/set_allowed_in_early_execution}}