Fixed casing and symbol of decorators to be consistent with the new convention

Perryvw · Perryvw · commit 3d994fa77664 · 2018-12-01T22:45:52.000+01:00
diff --git a/src/lualib/StringReplace.ts b/src/lualib/StringReplace.ts
@@ -1,5 +1,5 @@
 declare namespace string {
-    /** !TupleReturn */
+    /** @tupleReturn */
     function gsub(source: string, searchValue: string, replaceValue: string): [string, number];
 }
 
diff --git a/test/translation/ts/assignments.ts b/test/translation/ts/assignments.ts
@@ -10,7 +10,7 @@ declare function getIndex(): number;
 declare let xTup: [number, number];
 declare let yTup: [number, number];
 declare function getTup(): [number, number];
-/** !TupleReturn */
+/** @tupleReturn */
 declare function getTupRet(): [number, number];
 x = y;
 x = obj.prop;
diff --git a/test/translation/ts/classExtension1.ts b/test/translation/ts/classExtension1.ts
@@ -1,4 +1,4 @@
-/** !Extension */
+/** @extension */
 class MyClass {
     public myFunction() {}
 }
diff --git a/test/translation/ts/classExtension2.ts b/test/translation/ts/classExtension2.ts
@@ -1,8 +1,8 @@
-/** !Extension */
+/** @extension */
 class TestClass {
 }
 
-/** !Extension */
+/** @extension */
 class MyClass extends TestClass {
     public myFunction() {}
 }
diff --git a/test/translation/ts/classExtension3.ts b/test/translation/ts/classExtension3.ts
@@ -1,9 +1,9 @@
-/** !Extension RenamedTestClass */
+/** @extension RenamedTestClass */
 class TestClass {
     public myFunction() {}
 }
 
-/** !Extension RenamedMyClass */
+/** @extension RenamedMyClass */
 class MyClass extends TestClass {
     public myFunction() {}
 }
diff --git a/test/translation/ts/classExtension4.ts b/test/translation/ts/classExtension4.ts
@@ -1,4 +1,4 @@
-/** !Extension */
+/** @extension */
 class MyClass {
     public test: string = "test";
     private testP: string = "testP";
diff --git a/test/translation/ts/classPureAbstract.ts b/test/translation/ts/classPureAbstract.ts
@@ -1,3 +1,3 @@
-/** !PureAbstract */
+/** @pureAbstract */
 declare class ClassA {}
 class ClassB extends ClassA {}
diff --git a/test/translation/ts/enumMembersOnly.ts b/test/translation/ts/enumMembersOnly.ts
@@ -1,4 +1,4 @@
-/** !CompileMembersOnly */
+/** @compileMembersOnly */
 enum TestEnum {
     val1 = 0,
     val2 = 2,
diff --git a/test/translation/ts/namespacePhantom.ts b/test/translation/ts/namespacePhantom.ts
@@ -1,4 +1,4 @@
-/** !Phantom */
+/** @phantom */
 namespace myNamespace {
     function nsMember() {}
 }
diff --git a/test/translation/ts/tupleReturn.ts b/test/translation/ts/tupleReturn.ts
@@ -1,4 +1,4 @@
-/** !TupleReturn */
+/** @tupleReturn */
 function tupleReturn(): [number, string] {
     return [0, "foobar"];
 }
@@ -16,19 +16,19 @@ e = tupleReturn();
 f = noTupleReturn();
 foo(tupleReturn());
 foo(noTupleReturn());
-/** !TupleReturn */
+/** @tupleReturn */
 function tupleReturnFromVar(): [number, string] {
     const r: [number, string] = [1, "baz"];
     return r;
 }
-/** !TupleReturn */
+/** @tupleReturn */
 function tupleReturnForward(): [number, string] {
     return tupleReturn();
 }
 function tupleNoForward(): [number, string] {
     return tupleReturn();
 }
-/** !TupleReturn */
+/** @tupleReturn */
 function tupleReturnUnpack(): [number, string] {
     return tupleNoForward();
 }
diff --git a/test/unit/assignments.spec.ts b/test/unit/assignments.spec.ts
@@ -76,7 +76,7 @@ export class AssignmentTests {
 
     @Test("TupleReturn assignment")
     public tupleReturnFunction(): void {
-        const code = `/** !TupleReturn */\n`
+        const code = `/** @tupleReturn */\n`
                    + `declare function abc() { return [1,2,3]; }\n`
                    + `let [a,b] = abc();`;
 
@@ -86,7 +86,7 @@ export class AssignmentTests {
 
     @Test("TupleReturn Single assignment")
     public tupleReturnSingleAssignment(): void {
-        const code = `/** !TupleReturn */\n`
+        const code = `/** @tupleReturn */\n`
                    + `declare function abc(): [number, string]; }\n`
                    + `let a = abc();`
                    + `a = abc();`;
@@ -98,7 +98,7 @@ export class AssignmentTests {
     @Test("TupleReturn interface assignment")
     public tupleReturnInterface(): void {
         const code = `interface def {\n`
-                   + `/** !TupleReturn */\n`
+                   + `/** @tupleReturn */\n`
                    + `abc();\n`
                    + `} declare const jkl : def;\n`
                    + `let [a,b] = jkl.abc();`;
@@ -110,7 +110,7 @@ export class AssignmentTests {
     @Test("TupleReturn namespace assignment")
     public tupleReturnNameSpace(): void {
         const code = `declare namespace def {\n`
-                   + `/** !TupleReturn */\n`
+                   + `/** @tupleReturn */\n`
                    + `function abc() {}\n`
                    + `}\n`
                    + `let [a,b] = def.abc();`;
@@ -122,7 +122,7 @@ export class AssignmentTests {
     @Test("TupleReturn method assignment")
     public tupleReturnMethod(): void {
         const code = `declare class def {\n`
-                   + `/** !TupleReturn */\n`
+                   + `/** @tupleReturn */\n`
                    + `abc() { return [1,2,3]; }\n`
                    + `} const jkl = new def();\n`
                    + `let [a,b] = jkl.abc();`;
@@ -133,7 +133,7 @@ export class AssignmentTests {
 
     @Test("TupleReturn functional")
     public tupleReturnFunctional(): void {
-        const code = `/** !TupleReturn */
+        const code = `/** @tupleReturn */
         function abc(): [number, string] { return [3, "a"]; }
         const [a, b] = abc();
         return b + a;`;
@@ -147,7 +147,7 @@ export class AssignmentTests {
 
     @Test("TupleReturn single")
     public tupleReturnSingle(): void {
-        const code = `/** !TupleReturn */
+        const code = `/** @tupleReturn */
         function abc(): [number, string] { return [3, "a"]; }
         const res = abc();
         return res.length`;
@@ -161,7 +161,7 @@ export class AssignmentTests {
 
     @Test("TupleReturn in expression")
     public tupleReturnInExpression(): void {
-        const code = `/** !TupleReturn */
+        const code = `/** @tupleReturn */
         function abc(): [number, string] { return [3, "a"]; }
         return abc()[1] + abc()[0];`;
 
diff --git a/test/unit/decoratorCustomConstructor.spec.ts b/test/unit/decoratorCustomConstructor.spec.ts
@@ -9,7 +9,7 @@ export class DecoratorCustomConstructor {
     public customCreate(): void {
         // Transpile
         const lua = util.transpileString(
-            `/** !CustomConstructor Point2DCreate */
+            `/** @customConstructor Point2DCreate */
             class Point2D {
                 x: number;
                 y: number;
@@ -29,7 +29,7 @@ export class DecoratorCustomConstructor {
     public incorrectUsage(): void {
         Expect(() => {
             util.transpileString(
-                `/** !CustomConstructor */
+                `/** @customConstructor */
                 class Point2D {
                     x: number;
                     y: number;
diff --git a/test/unit/decoratorMetaExtension.spec.ts b/test/unit/decoratorMetaExtension.spec.ts
@@ -14,7 +14,7 @@ export class DecoratorMetaExtension {
             declare namespace debug {
                 function getregistry(): any;
             }
-            /** !MetaExtension */
+            /** @metaExtension */
             class LoadedExt extends _LOADED {
                 public static test() {
                     return 5;
@@ -33,7 +33,7 @@ export class DecoratorMetaExtension {
         Expect(() => {
             util.transpileString(
                 `
-                /** !MetaExtension */
+                /** @metaExtension */
                 class LoadedExt {
                     public static test() {
                         return 5;
@@ -51,7 +51,7 @@ export class DecoratorMetaExtension {
             util.transpileString(
                 `
                 declare class _LOADED;
-                /** !MetaExtension */
+                /** @metaExtension */
                 class Ext extends _LOADED {
                 }
                 const e = new Ext();
diff --git a/test/unit/expressions.spec.ts b/test/unit/expressions.spec.ts
@@ -324,7 +324,7 @@ export class ExpressionTests {
             `let x: [string, string] = ["x0", "x1"];
             let y: [string, string] = ["y0", "y1"];
             function t(): [string, string] { return ["t0", "t1"] };
-            /** !TupleReturn */
+            /** @tupleReturn */
             function tr(): [string, string] { return ["tr0", "tr1"] };
             const r = ${expression};
             return \`\${r[0]},\${r[1]}\``);
diff --git a/test/unit/tshelper.spec.ts b/test/unit/tshelper.spec.ts
@@ -42,7 +42,7 @@ export class TSHelperTests {
 
     @Test("GetCustomDecorators single")
     public GetCustomDecoratorsSingle(): void {
-        const source = `/** !CompileMembersOnly */
+        const source = `/** @compileMembersOnly */
             enum TestEnum {
                 val1 = 0,
                 val2 = 2,
@@ -64,8 +64,8 @@ export class TSHelperTests {
 
     @Test("GetCustomDecorators multiple")
     public GetCustomDecoratorsMultiple(): void {
-        const source = `/** !CompileMembersOnly
-            * !Phantom */
+        const source = `/** @compileMembersOnly
+            * @Phantom */
             enum TestEnum {
                 val1 = 0,
                 val2 = 2,
@@ -88,7 +88,7 @@ export class TSHelperTests {
 
     @Test("GetCustomDecorators single jsdoc")
     public GetCustomDecoratorsSingleJSDoc(): void {
-        const source = `/** @CompileMembersOnly */
+        const source = `/** @compileMembersOnly */
             enum TestEnum {
                 val1 = 0,
                 val2 = 2,
@@ -110,7 +110,7 @@ export class TSHelperTests {
 
     @Test("GetCustomDecorators multiple jsdoc")
     public GetCustomDecoratorsMultipleJSDoc(): void {
-        const source = `/** @Phantom
+        const source = `/** @phantom
             * @CompileMembersOnly */
             enum TestEnum {
                 val1 = 0,
@@ -136,8 +136,8 @@ export class TSHelperTests {
     public GetCustomDecoratorsMultipleDefaultJSDoc(): void {
         const source = `/**
             * @description abc
-            * @Phantom
-            * @CompileMembersOnly */
+            * @phantom
+            * @compileMembersOnly */
             enum TestEnum {
                 val1 = 0,
                 val2 = 2,
diff --git a/test/unit/tuples.spec.ts b/test/unit/tuples.spec.ts
@@ -82,7 +82,7 @@ export class TupleTests {
     public tupleDestruct(): void {
         // Transpile
         const lua = util.transpileString(
-            `function tuple(): [number, number, number] { return [3,5,1]; }\n
+            `function tuple(): [number, number, number] { return [3,5,1]; }
             const [a,b,c] = tuple();
             return b;`
         );
@@ -113,8 +113,8 @@ export class TupleTests {
     public tupleReturnAccess(): void {
         // Transpile
         const lua = util.transpileString(
-            `/** !TupleReturn */\n
-            function tuple(): [number, number, number] { return [3,5,1]; }\n
+            `/** @tupleReturn */
+            function tuple(): [number, number, number] { return [3,5,1]; }
             return tuple()[2];`
         );
 
@@ -129,8 +129,8 @@ export class TupleTests {
     public tupleReturnDestructDeclaration(): void {
         // Transpile
         const lua = util.transpileString(
-            `/** !TupleReturn */\n
-            function tuple(): [number, number, number] { return [3,5,1]; }\n
+            `/** @tupleReturn */
+            function tuple(): [number, number, number] { return [3,5,1]; }
             const [a,b,c] = tuple();
             return b;`
         );
@@ -146,8 +146,8 @@ export class TupleTests {
     public tupleReturnDestructAssignment(): void {
         // Transpile
         const lua = util.transpileString(
-            `/** !TupleReturn */\n
-            function tuple(): [number, number] { return [3,6]; }\n
+            `/** @tupleReturn */
+            function tuple(): [number, number] { return [3,6]; }
             const [a,b] = [1,2];
             [b,a] = tuple();
             return a - b;`
@@ -164,10 +164,10 @@ export class TupleTests {
     public tupleStaticMethodReturnDestruct(): void {
         // Transpile
         const lua = util.transpileString(
-            `class Test {\n
-                /** !TupleReturn */\n
-                static tuple(): [number, number, number] { return [3,5,1]; }\n
-            }\n
+            `class Test {
+                /** @tupleReturn */
+                static tuple(): [number, number, number] { return [3,5,1]; }
+            }
             const [a,b,c] = Test.tuple();
             return b;`
         );
@@ -183,10 +183,10 @@ export class TupleTests {
     public tupleMethodNonStaticReturnDestruct(): void {
         // Transpile
         const lua = util.transpileString(
-            `class Test {\n
-                /** !TupleReturn */\n
-                tuple(): [number, number, number] { return [3,5,1]; }\n
-            }\n
+            `class Test {
+                /** @tupleReturn */
+                tuple(): [number, number, number] { return [3,5,1]; }
+            }
             const t = new Test();
             const [a,b,c] = t.tuple();
             return b;`

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`declare namespace string {`
`2`		`- /** !TupleReturn */`
	`2`	`+ /** @tupleReturn */`
`3`	`3`	`function gsub(source: string, searchValue: string, replaceValue: string): [string, number];`
`4`	`4`	`}`
`5`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/** !Extension */`
	`1`	`+/** @extension */`
`2`	`2`	`class MyClass {`
`3`	`3`	`public myFunction() {}`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`		`-/** !Extension */`
	`1`	`+/** @extension */`
`2`	`2`	`class TestClass {`
`3`	`3`	`}`
`4`	`4`
`5`		`-/** !Extension */`
	`5`	`+/** @extension */`
`6`	`6`	`class MyClass extends TestClass {`
`7`	`7`	`public myFunction() {}`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`		`-/** !Extension RenamedTestClass */`
	`1`	`+/** @extension RenamedTestClass */`
`2`	`2`	`class TestClass {`
`3`	`3`	`public myFunction() {}`
`4`	`4`	`}`
`5`	`5`
`6`		`-/** !Extension RenamedMyClass */`
	`6`	`+/** @extension RenamedMyClass */`
`7`	`7`	`class MyClass extends TestClass {`
`8`	`8`	`public myFunction() {}`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/** !CompileMembersOnly */`
	`1`	`+/** @compileMembersOnly */`
`2`	`2`	`enum TestEnum {`
`3`	`3`	`val1 = 0,`
`4`	`4`	`val2 = 2,`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/** !Phantom */`
	`1`	`+/** @phantom */`
`2`	`2`	`namespace myNamespace {`
`3`	`3`	`function nsMember() {}`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/** !TupleReturn */`
	`1`	`+/** @tupleReturn */`
`2`	`2`	`function tupleReturn(): [number, string] {`
`3`	`3`	`return [0, "foobar"];`
`4`	`4`	`}`
`@@ -16,19 +16,19 @@ e = tupleReturn();`
`16`	`16`	`f = noTupleReturn();`
`17`	`17`	`foo(tupleReturn());`
`18`	`18`	`foo(noTupleReturn());`
`19`		`-/** !TupleReturn */`
	`19`	`+/** @tupleReturn */`
`20`	`20`	`function tupleReturnFromVar(): [number, string] {`
`21`	`21`	`const r: [number, string] = [1, "baz"];`
`22`	`22`	`return r;`
`23`	`23`	`}`
`24`		`-/** !TupleReturn */`
	`24`	`+/** @tupleReturn */`
`25`	`25`	`function tupleReturnForward(): [number, string] {`
`26`	`26`	`return tupleReturn();`
`27`	`27`	`}`
`28`	`28`	`function tupleNoForward(): [number, string] {`
`29`	`29`	`return tupleReturn();`
`30`	`30`	`}`
`31`		`-/** !TupleReturn */`
	`31`	`+/** @tupleReturn */`
`32`	`32`	`function tupleReturnUnpack(): [number, string] {`
`33`	`33`	`return tupleNoForward();`
`34`	`34`	`}`