Skip to content

Add ts doc tags for api privilege levels #147

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
BrandonChanSkybox wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add ts doc tags for api privilege levels #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c685446
Markup changes and update tests
BrandonChanSkybox Jul 7, 2026
c17ee9a
Change files
BrandonChanSkybox Jul 7, 2026
99de43a
Update tag
BrandonChanSkybox Jul 9, 2026
bfcd9df
Merge remote-tracking branch 'origin/main' into AddTSDocTagsForAPIPri…
BrandonChanSkybox Jul 13, 2026
ff9ee94
Fix Spelling
BrandonChanSkybox Jul 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions change/@minecraft-markup-generators-plugin-de097a3a-1fb3-4d2d-8505-133ae7789860.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "Add tags for priviledge levels",
"packageName": "@minecraft/markup-generators-plugin",
"email": "brandon.chan@skyboxlabs.com",
"dependentChangeType": "patch"
}
4 changes: 2 additions & 2 deletions ...or-test-snapshots/test/additive_beta_change/__snapshots__/additiveBetaChange.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ export class ExampleClass1 {
private constructor();
/**
* @remarks
* 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;
Expand Down Expand Up @@ -226,7 +226,7 @@ export class ExampleClass1 {
private constructor();
/**
* @remarks
* 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;
Expand Down
2 changes: 1 addition & 1 deletion ...pshots/test/array_of_optional_variants/__snapshots__/arrayOfOptionalVariants.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ export class ClassWithArrayOfVariantsProperty {
private constructor();
/**
* @remarks
* 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)[];
Expand Down
2 changes: 1 addition & 1 deletion ...enerator-test-snapshots/test/array_of_variants/__snapshots__/arrayOfVariants.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ export class ClassWithArrayOfVariantsProperty {
private constructor();
/**
* @remarks
* 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)[];
Expand Down
40 changes: 20 additions & 20 deletions tools/api-docs-generator-test-snapshots/test/bounds/__snapshots__/bounds.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,68 +479,68 @@ export class ClassWithBounds {
private constructor();
/**
* @remarks
* 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
* 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
* 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
* 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
* 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
* 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
* 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
* 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
* 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
* 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
Expand Down Expand Up @@ -602,68 +602,68 @@ export class ClassWithBounds {
private constructor();
/**
* @remarks
* 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
* 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
* 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
* 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
* 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
* 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
* 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
* 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
* 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
* 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
Expand Down
Loading
Loading