Update JavaScript IDL generator to remove invalid Closure JSDoc comments (#4873)

* Update JavaScript IDL generator to remove invalid Closure JSDoc comments * Revert erroneous changes * A few more tweaks * Updated generated code
2026-06-22 23:38:52 +00:00 · 2018-08-10 15:27:51 -07:00
parent 12e5cf0b29
commit aaa89429d3
9 changed files with 835 additions and 880 deletions
--- a/tests/namespace_test/NamespaceA/NamespaceB/EnumInNestedNS.go
+++ b/tests/namespace_test/NamespaceA/NamespaceB/EnumInNestedNS.go
@@ -2,13 +2,14 @@

 package NamespaceB

+type EnumInNestedNS = int8
 const (
-	EnumInNestedNSA = 0
-	EnumInNestedNSB = 1
-	EnumInNestedNSC = 2
+	EnumInNestedNSA EnumInNestedNS = 0
+	EnumInNestedNSB EnumInNestedNS = 1
+	EnumInNestedNSC EnumInNestedNS = 2
 )

-var EnumNamesEnumInNestedNS = map[int]string{
+var EnumNamesEnumInNestedNS = map[EnumInNestedNS]string{
 	EnumInNestedNSA:"A",
 	EnumInNestedNSB:"B",
 	EnumInNestedNSC:"C",
--- a/tests/namespace_test/namespace_test1_generated.ts
+++ b/tests/namespace_test/namespace_test1_generated.ts
@@ -15,19 +15,13 @@ export enum EnumInNestedNS{
 */
 export namespace NamespaceA.NamespaceB{
 export class TableInNestedNS {
-  /**
-   * @type {flatbuffers.ByteBuffer}
-   */
  bb: flatbuffers.ByteBuffer|null = null;

-  /**
-   * @type {number}
-   */
  bb_pos:number = 0;
 /**
- * @param {number} i
- * @param {flatbuffers.ByteBuffer} bb
- * @returns {TableInNestedNS}
+ * @param number i
+ * @param flatbuffers.ByteBuffer bb
+ * @returns TableInNestedNS
 */
 __init(i:number, bb:flatbuffers.ByteBuffer):TableInNestedNS {
  this.bb_pos = i;
@@ -36,16 +30,16 @@ __init(i:number, bb:flatbuffers.ByteBuffer):TableInNestedNS {
 };

 /**
- * @param {flatbuffers.ByteBuffer} bb
- * @param {TableInNestedNS=} obj
- * @returns {TableInNestedNS}
+ * @param flatbuffers.ByteBuffer bb
+ * @param TableInNestedNS= obj
+ * @returns TableInNestedNS
 */
 static getRootAsTableInNestedNS(bb:flatbuffers.ByteBuffer, obj?:TableInNestedNS):TableInNestedNS {
  return (obj || new TableInNestedNS).__init(bb.readInt32(bb.position()) + bb.position(), bb);
 };

 /**
- * @returns {number}
+ * @returns number
 */
 foo():number {
  var offset = this.bb!.__offset(this.bb_pos, 4);
@@ -53,8 +47,8 @@ foo():number {
 };

 /**
- * @param {number} value
- * @returns {boolean}
+ * @param number value
+ * @returns boolean
 */
 mutate_foo(value:number):boolean {
  var offset = this.bb!.__offset(this.bb_pos, 4);
@@ -68,23 +62,23 @@ mutate_foo(value:number):boolean {
 };

 /**
- * @param {flatbuffers.Builder} builder
+ * @param flatbuffers.Builder builder
 */
 static startTableInNestedNS(builder:flatbuffers.Builder) {
  builder.startObject(1);
 };

 /**
- * @param {flatbuffers.Builder} builder
- * @param {number} foo
+ * @param flatbuffers.Builder builder
+ * @param number foo
 */
 static addFoo(builder:flatbuffers.Builder, foo:number) {
  builder.addFieldInt32(0, foo, 0);
 };

 /**
- * @param {flatbuffers.Builder} builder
- * @returns {flatbuffers.Offset}
+ * @param flatbuffers.Builder builder
+ * @returns flatbuffers.Offset
 */
 static endTableInNestedNS(builder:flatbuffers.Builder):flatbuffers.Offset {
  var offset = builder.endObject();
@@ -98,19 +92,13 @@ static endTableInNestedNS(builder:flatbuffers.Builder):flatbuffers.Offset {
 */
 export namespace NamespaceA.NamespaceB{
 export class StructInNestedNS {
-  /**
-   * @type {flatbuffers.ByteBuffer}
-   */
  bb: flatbuffers.ByteBuffer|null = null;

-  /**
-   * @type {number}
-   */
  bb_pos:number = 0;
 /**
- * @param {number} i
- * @param {flatbuffers.ByteBuffer} bb
- * @returns {StructInNestedNS}
+ * @param number i
+ * @param flatbuffers.ByteBuffer bb
+ * @returns StructInNestedNS
 */
 __init(i:number, bb:flatbuffers.ByteBuffer):StructInNestedNS {
  this.bb_pos = i;
@@ -119,15 +107,15 @@ __init(i:number, bb:flatbuffers.ByteBuffer):StructInNestedNS {
 };

 /**
- * @returns {number}
+ * @returns number
 */
 a():number {
  return this.bb!.readInt32(this.bb_pos);
 };

 /**
- * @param {number} value
- * @returns {boolean}
+ * @param number value
+ * @returns boolean
 */
 mutate_a(value:number):boolean {
  var offset = this.bb!.__offset(this.bb_pos, 0);
@@ -141,15 +129,15 @@ mutate_a(value:number):boolean {
 };

 /**
- * @returns {number}
+ * @returns number
 */
 b():number {
  return this.bb!.readInt32(this.bb_pos + 4);
 };

 /**
- * @param {number} value
- * @returns {boolean}
+ * @param number value
+ * @returns boolean
 */
 mutate_b(value:number):boolean {
  var offset = this.bb!.__offset(this.bb_pos, 4);
@@ -163,10 +151,10 @@ mutate_b(value:number):boolean {
 };

 /**
- * @param {flatbuffers.Builder} builder
- * @param {number} a
- * @param {number} b
- * @returns {flatbuffers.Offset}
+ * @param flatbuffers.Builder builder
+ * @param number a
+ * @param number b
+ * @returns flatbuffers.Offset
 */
 static createStructInNestedNS(builder:flatbuffers.Builder, a: number, b: number):flatbuffers.Offset {
  builder.prep(4, 8);
--- a/tests/namespace_test/namespace_test2_generated.ts
+++ b/tests/namespace_test/namespace_test2_generated.ts
@@ -1,24 +1,18 @@
 // automatically generated by the FlatBuffers compiler, do not modify

-import * as NS11563891686210618450 from "./namespace_test1_generated";
+import * as NS4989953370203581498 from "./namespace_test1_generated";
 /**
 * @constructor
 */
 export namespace NamespaceA{
 export class TableInFirstNS {
-  /**
-   * @type {flatbuffers.ByteBuffer}
-   */
  bb: flatbuffers.ByteBuffer|null = null;

-  /**
-   * @type {number}
-   */
  bb_pos:number = 0;
 /**
- * @param {number} i
- * @param {flatbuffers.ByteBuffer} bb
- * @returns {TableInFirstNS}
+ * @param number i
+ * @param flatbuffers.ByteBuffer bb
+ * @returns TableInFirstNS
 */
 __init(i:number, bb:flatbuffers.ByteBuffer):TableInFirstNS {
  this.bb_pos = i;
@@ -27,36 +21,36 @@ __init(i:number, bb:flatbuffers.ByteBuffer):TableInFirstNS {
 };

 /**
- * @param {flatbuffers.ByteBuffer} bb
- * @param {TableInFirstNS=} obj
- * @returns {TableInFirstNS}
+ * @param flatbuffers.ByteBuffer bb
+ * @param TableInFirstNS= obj
+ * @returns TableInFirstNS
 */
 static getRootAsTableInFirstNS(bb:flatbuffers.ByteBuffer, obj?:TableInFirstNS):TableInFirstNS {
  return (obj || new TableInFirstNS).__init(bb.readInt32(bb.position()) + bb.position(), bb);
 };

 /**
- * @param {NamespaceA.NamespaceB.TableInNestedNS=} obj
- * @returns {NamespaceA.NamespaceB.TableInNestedNS|null}
+ * @param NamespaceA.NamespaceB.TableInNestedNS= obj
+ * @returns NamespaceA.NamespaceB.TableInNestedNS|null
 */
-fooTable(obj?:NS11563891686210618450.NamespaceA.NamespaceB.TableInNestedNS):NS11563891686210618450.NamespaceA.NamespaceB.TableInNestedNS|null {
+fooTable(obj?:NS4989953370203581498.NamespaceA.NamespaceB.TableInNestedNS):NS4989953370203581498.NamespaceA.NamespaceB.TableInNestedNS|null {
  var offset = this.bb!.__offset(this.bb_pos, 4);
-  return offset ? (obj || new NS11563891686210618450.NamespaceA.NamespaceB.TableInNestedNS).__init(this.bb!.__indirect(this.bb_pos + offset), this.bb!) : null;
+  return offset ? (obj || new NS4989953370203581498.NamespaceA.NamespaceB.TableInNestedNS).__init(this.bb!.__indirect(this.bb_pos + offset), this.bb!) : null;
 };

 /**
- * @returns {NamespaceA.NamespaceB.EnumInNestedNS}
+ * @returns NamespaceA.NamespaceB.EnumInNestedNS
 */
-fooEnum():NS11563891686210618450.NamespaceA.NamespaceB.EnumInNestedNS {
+fooEnum():NS4989953370203581498.NamespaceA.NamespaceB.EnumInNestedNS {
  var offset = this.bb!.__offset(this.bb_pos, 6);
-  return offset ? /** @type {NamespaceA.NamespaceB.EnumInNestedNS} */ (this.bb!.readInt8(this.bb_pos + offset)) : NS11563891686210618450.NamespaceA.NamespaceB.EnumInNestedNS.A;
+  return offset ? /**  */ (this.bb!.readInt8(this.bb_pos + offset)) : NS4989953370203581498.NamespaceA.NamespaceB.EnumInNestedNS.A;
 };

 /**
- * @param {NamespaceA.NamespaceB.EnumInNestedNS} value
- * @returns {boolean}
+ * @param NamespaceA.NamespaceB.EnumInNestedNS value
+ * @returns boolean
 */
-mutate_foo_enum(value:NS11563891686210618450.NamespaceA.NamespaceB.EnumInNestedNS):boolean {
+mutate_foo_enum(value:NS4989953370203581498.NamespaceA.NamespaceB.EnumInNestedNS):boolean {
  var offset = this.bb!.__offset(this.bb_pos, 6);

  if (offset === 0) {
@@ -68,48 +62,48 @@ mutate_foo_enum(value:NS11563891686210618450.NamespaceA.NamespaceB.EnumInNestedN
 };

 /**
- * @param {NamespaceA.NamespaceB.StructInNestedNS=} obj
- * @returns {NamespaceA.NamespaceB.StructInNestedNS|null}
+ * @param NamespaceA.NamespaceB.StructInNestedNS= obj
+ * @returns NamespaceA.NamespaceB.StructInNestedNS|null
 */
-fooStruct(obj?:NS11563891686210618450.NamespaceA.NamespaceB.StructInNestedNS):NS11563891686210618450.NamespaceA.NamespaceB.StructInNestedNS|null {
+fooStruct(obj?:NS4989953370203581498.NamespaceA.NamespaceB.StructInNestedNS):NS4989953370203581498.NamespaceA.NamespaceB.StructInNestedNS|null {
  var offset = this.bb!.__offset(this.bb_pos, 8);
-  return offset ? (obj || new NS11563891686210618450.NamespaceA.NamespaceB.StructInNestedNS).__init(this.bb_pos + offset, this.bb!) : null;
+  return offset ? (obj || new NS4989953370203581498.NamespaceA.NamespaceB.StructInNestedNS).__init(this.bb_pos + offset, this.bb!) : null;
 };

 /**
- * @param {flatbuffers.Builder} builder
+ * @param flatbuffers.Builder builder
 */
 static startTableInFirstNS(builder:flatbuffers.Builder) {
  builder.startObject(3);
 };

 /**
- * @param {flatbuffers.Builder} builder
- * @param {flatbuffers.Offset} fooTableOffset
+ * @param flatbuffers.Builder builder
+ * @param flatbuffers.Offset fooTableOffset
 */
 static addFooTable(builder:flatbuffers.Builder, fooTableOffset:flatbuffers.Offset) {
  builder.addFieldOffset(0, fooTableOffset, 0);
 };

 /**
- * @param {flatbuffers.Builder} builder
- * @param {NamespaceA.NamespaceB.EnumInNestedNS} fooEnum
+ * @param flatbuffers.Builder builder
+ * @param NamespaceA.NamespaceB.EnumInNestedNS fooEnum
 */
-static addFooEnum(builder:flatbuffers.Builder, fooEnum:NS11563891686210618450.NamespaceA.NamespaceB.EnumInNestedNS) {
-  builder.addFieldInt8(1, fooEnum, NS11563891686210618450.NamespaceA.NamespaceB.EnumInNestedNS.A);
+static addFooEnum(builder:flatbuffers.Builder, fooEnum:NS4989953370203581498.NamespaceA.NamespaceB.EnumInNestedNS) {
+  builder.addFieldInt8(1, fooEnum, NS4989953370203581498.NamespaceA.NamespaceB.EnumInNestedNS.A);
 };

 /**
- * @param {flatbuffers.Builder} builder
- * @param {flatbuffers.Offset} fooStructOffset
+ * @param flatbuffers.Builder builder
+ * @param flatbuffers.Offset fooStructOffset
 */
 static addFooStruct(builder:flatbuffers.Builder, fooStructOffset:flatbuffers.Offset) {
  builder.addFieldStruct(2, fooStructOffset, 0);
 };

 /**
- * @param {flatbuffers.Builder} builder
- * @returns {flatbuffers.Offset}
+ * @param flatbuffers.Builder builder
+ * @returns flatbuffers.Offset
 */
 static endTableInFirstNS(builder:flatbuffers.Builder):flatbuffers.Offset {
  var offset = builder.endObject();
@@ -123,19 +117,13 @@ static endTableInFirstNS(builder:flatbuffers.Builder):flatbuffers.Offset {
 */
 export namespace NamespaceC{
 export class TableInC {
-  /**
-   * @type {flatbuffers.ByteBuffer}
-   */
  bb: flatbuffers.ByteBuffer|null = null;

-  /**
-   * @type {number}
-   */
  bb_pos:number = 0;
 /**
- * @param {number} i
- * @param {flatbuffers.ByteBuffer} bb
- * @returns {TableInC}
+ * @param number i
+ * @param flatbuffers.ByteBuffer bb
+ * @returns TableInC
 */
 __init(i:number, bb:flatbuffers.ByteBuffer):TableInC {
  this.bb_pos = i;
@@ -144,17 +132,17 @@ __init(i:number, bb:flatbuffers.ByteBuffer):TableInC {
 };

 /**
- * @param {flatbuffers.ByteBuffer} bb
- * @param {TableInC=} obj
- * @returns {TableInC}
+ * @param flatbuffers.ByteBuffer bb
+ * @param TableInC= obj
+ * @returns TableInC
 */
 static getRootAsTableInC(bb:flatbuffers.ByteBuffer, obj?:TableInC):TableInC {
  return (obj || new TableInC).__init(bb.readInt32(bb.position()) + bb.position(), bb);
 };

 /**
- * @param {NamespaceA.TableInFirstNS=} obj
- * @returns {NamespaceA.TableInFirstNS|null}
+ * @param NamespaceA.TableInFirstNS= obj
+ * @returns NamespaceA.TableInFirstNS|null
 */
 referToA1(obj?:NamespaceA.TableInFirstNS):NamespaceA.TableInFirstNS|null {
  var offset = this.bb!.__offset(this.bb_pos, 4);
@@ -162,8 +150,8 @@ referToA1(obj?:NamespaceA.TableInFirstNS):NamespaceA.TableInFirstNS|null {
 };

 /**
- * @param {NamespaceA.SecondTableInA=} obj
- * @returns {NamespaceA.SecondTableInA|null}
+ * @param NamespaceA.SecondTableInA= obj
+ * @returns NamespaceA.SecondTableInA|null
 */
 referToA2(obj?:NamespaceA.SecondTableInA):NamespaceA.SecondTableInA|null {
  var offset = this.bb!.__offset(this.bb_pos, 6);
@@ -171,31 +159,31 @@ referToA2(obj?:NamespaceA.SecondTableInA):NamespaceA.SecondTableInA|null {
 };

 /**
- * @param {flatbuffers.Builder} builder
+ * @param flatbuffers.Builder builder
 */
 static startTableInC(builder:flatbuffers.Builder) {
  builder.startObject(2);
 };

 /**
- * @param {flatbuffers.Builder} builder
- * @param {flatbuffers.Offset} referToA1Offset
+ * @param flatbuffers.Builder builder
+ * @param flatbuffers.Offset referToA1Offset
 */
 static addReferToA1(builder:flatbuffers.Builder, referToA1Offset:flatbuffers.Offset) {
  builder.addFieldOffset(0, referToA1Offset, 0);
 };

 /**
- * @param {flatbuffers.Builder} builder
- * @param {flatbuffers.Offset} referToA2Offset
+ * @param flatbuffers.Builder builder
+ * @param flatbuffers.Offset referToA2Offset
 */
 static addReferToA2(builder:flatbuffers.Builder, referToA2Offset:flatbuffers.Offset) {
  builder.addFieldOffset(1, referToA2Offset, 0);
 };

 /**
- * @param {flatbuffers.Builder} builder
- * @returns {flatbuffers.Offset}
+ * @param flatbuffers.Builder builder
+ * @returns flatbuffers.Offset
 */
 static endTableInC(builder:flatbuffers.Builder):flatbuffers.Offset {
  var offset = builder.endObject();
@@ -209,19 +197,13 @@ static endTableInC(builder:flatbuffers.Builder):flatbuffers.Offset {
 */
 export namespace NamespaceA{
 export class SecondTableInA {
-  /**
-   * @type {flatbuffers.ByteBuffer}
-   */
  bb: flatbuffers.ByteBuffer|null = null;

-  /**
-   * @type {number}
-   */
  bb_pos:number = 0;
 /**
- * @param {number} i
- * @param {flatbuffers.ByteBuffer} bb
- * @returns {SecondTableInA}
+ * @param number i
+ * @param flatbuffers.ByteBuffer bb
+ * @returns SecondTableInA
 */
 __init(i:number, bb:flatbuffers.ByteBuffer):SecondTableInA {
  this.bb_pos = i;
@@ -230,17 +212,17 @@ __init(i:number, bb:flatbuffers.ByteBuffer):SecondTableInA {
 };

 /**
- * @param {flatbuffers.ByteBuffer} bb
- * @param {SecondTableInA=} obj
- * @returns {SecondTableInA}
+ * @param flatbuffers.ByteBuffer bb
+ * @param SecondTableInA= obj
+ * @returns SecondTableInA
 */
 static getRootAsSecondTableInA(bb:flatbuffers.ByteBuffer, obj?:SecondTableInA):SecondTableInA {
  return (obj || new SecondTableInA).__init(bb.readInt32(bb.position()) + bb.position(), bb);
 };

 /**
- * @param {NamespaceC.TableInC=} obj
- * @returns {NamespaceC.TableInC|null}
+ * @param NamespaceC.TableInC= obj
+ * @returns NamespaceC.TableInC|null
 */
 referToC(obj?:NamespaceC.TableInC):NamespaceC.TableInC|null {
  var offset = this.bb!.__offset(this.bb_pos, 4);
@@ -248,23 +230,23 @@ referToC(obj?:NamespaceC.TableInC):NamespaceC.TableInC|null {
 };

 /**
- * @param {flatbuffers.Builder} builder
+ * @param flatbuffers.Builder builder
 */
 static startSecondTableInA(builder:flatbuffers.Builder) {
  builder.startObject(1);
 };

 /**
- * @param {flatbuffers.Builder} builder
- * @param {flatbuffers.Offset} referToCOffset
+ * @param flatbuffers.Builder builder
+ * @param flatbuffers.Offset referToCOffset
 */
 static addReferToC(builder:flatbuffers.Builder, referToCOffset:flatbuffers.Offset) {
  builder.addFieldOffset(0, referToCOffset, 0);
 };

 /**
- * @param {flatbuffers.Builder} builder
- * @returns {flatbuffers.Offset}
+ * @param flatbuffers.Builder builder
+ * @returns flatbuffers.Offset
 */
 static endSecondTableInA(builder:flatbuffers.Builder):flatbuffers.Offset {
  var offset = builder.endObject();