diff --git a/src/lib/converter/converter.ts b/src/lib/converter/converter.ts index 0a16af6ad..fb7a8dcb1 100644 --- a/src/lib/converter/converter.ts +++ b/src/lib/converter/converter.ts @@ -346,7 +346,7 @@ export class Converter extends ChildableComponent< this.excludeNotDocumented && // If the enum is included, we should include members even if not documented. !hasFlag(symbol.flags, ts.SymbolFlags.EnumMember) && - !symbol.getDocumentationComment(checker) + symbol.getDocumentationComment(checker).length === 0 ) { return true; } diff --git a/src/test/converter/variables/specs.nodoc.json b/src/test/converter/variables/specs.nodoc.json index 64cff679f..1b0391fce 100644 --- a/src/test/converter/variables/specs.nodoc.json +++ b/src/test/converter/variables/specs.nodoc.json @@ -301,177 +301,6 @@ "kindString": "Module", "flags": {}, "children": [ - { - "id": 22, - "name": "destructArrayA", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 23, - "name": "destructArrayB", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 24, - "name": "destructArrayC", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": 0 - }, - { - "type": "literal", - "value": 10 - } - ] - }, - "defaultValue": "10" - }, - { - "id": 28, - "name": "destructArrayWithIgnoresA", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 29, - "name": "destructArrayWithIgnoresRest", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 27, - "name": "destructArrayWithRest", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 25, - "name": "destructArrayWithRestA", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 26, - "name": "destructArrayWithRestB", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 19, - "name": "destructObjectA", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 20, - "name": "destructObjectB", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 21, - "name": "destructObjectC", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, { "id": 16, "name": "drawText", @@ -510,23 +339,6 @@ } ], "groups": [ - { - "title": "Variables", - "kind": 32, - "children": [ - 22, - 23, - 24, - 28, - 29, - 27, - 25, - 26, - 19, - 20, - 21 - ] - }, { "title": "Functions", "kind": 64, @@ -537,524 +349,14 @@ ] }, { - "id": 30, + "id": 19, "name": "literal", "kind": 1, "kindString": "Module", "flags": {}, "children": [ { - "id": 50, - "name": "callbackReturn", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 51, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 58, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 59, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 60, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 61, - "name": "errorCallback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 62, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 63, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "unknown", - "name": "{ success: (successCallback: () => any) => ...; error: (errorCallback: () => any) => ...; finally: (finallyCallback: () => any) => ...; }" - } - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 64, - "name": "finally", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 65, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 66, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 67, - "name": "finallyCallback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 68, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 69, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "unknown", - "name": "{ success: (successCallback: () => any) => ...; error: (errorCallback: () => any) => ...; finally: (finallyCallback: () => any) => ...; }" - } - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 52, - "name": "success", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 53, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 54, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 55, - "name": "successCallback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 56, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 57, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "type": { - "type": "unknown", - "name": "{ success: (successCallback: () => any) => ...; error: (errorCallback: () => any) => ...; finally: (finallyCallback: () => any) => ...; }" - } - } - ] - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 58, - 64, - 52 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 70, - "name": "objectLiteral", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "comment": { - "shortText": "An object literal." - }, - "type": { - "type": "reflection", - "declaration": { - "id": 71, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 89, - "name": "[Symbol.toStringTag]", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "\"computed\"" - }, - { - "id": 90, - "name": "literal", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 91, - "name": "literal2", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 87, - "name": "valueA", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "100" - }, - { - "id": 88, - "name": "valueB", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 76, - "name": "valueX", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 77, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 86, - "name": "valueA", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "number" - } - }, - "defaultValue": "..." - }, - { - "id": 79, - "name": "valueY", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 80, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 81, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 82, - "name": "z", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 83, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 84, - "name": "a", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "\"test\"" - }, - { - "id": 85, - "name": "b", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 84, - 85 - ] - } - ] - } - } - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 78, - "name": "valueZ", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "\"foo\"" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 86, - 79, - 78 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 73, - "name": "valueY", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 74, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 75, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 72, - "name": "valueZ", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "\"foo\"" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 89, - 90, - 91, - 87, - 88, - 76, - 73, - 72 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 31, + "id": 20, "name": "typeLiteral", "kind": 32, "kindString": "Variable", @@ -1067,231 +369,11 @@ "type": { "type": "reflection", "declaration": { - "id": 32, + "id": 21, "name": "__type", "kind": 65536, "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 48, - "name": "valueA", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 49, - "name": "valueB", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 37, - "name": "valueX", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 38, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 47, - "name": "valueA", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 40, - "name": "valueY", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 41, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 42, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 43, - "name": "z", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 44, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 45, - "name": "a", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 46, - "name": "b", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 45, - 46 - ] - } - ] - } - } - } - ] - } - } - }, - { - "id": 39, - "name": "valueZ", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 47, - 40, - 39 - ] - } - ] - } - } - }, - { - "id": 34, - "name": "valueY", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 35, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 36, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 33, - "name": "valueZ", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 48, - 49, - 37, - 34, - 33 - ] - } - ] + "flags": {} } } } @@ -1301,126 +383,17 @@ "title": "Variables", "kind": 32, "children": [ - 50, - 70, - 31 + 20 ] } ] }, { - "id": 92, + "id": 22, "name": "variable", "kind": 1, "kindString": "Module", - "flags": {}, - "children": [ - { - "id": 93, - "name": "myConst", - "kind": 32, - "kindString": "Variable", - "flags": { - "isConst": true - }, - "type": { - "type": "literal", - "value": 15 - }, - "defaultValue": "15" - }, - { - "id": 94, - "name": "myLet", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "15" - }, - { - "id": 95, - "name": "myVar", - "kind": 32, - "kindString": "Variable", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "15" - }, - { - "id": 96, - "name": "x", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 97, - "name": "y", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise" - } - }, - { - "id": 98, - "name": "z", - "kind": 32, - "kindString": "Variable", - "flags": { - "isLet": true - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "object" - } - ], - "name": "Promise" - } - } - ], - "groups": [ - { - "title": "Variables", - "kind": 32, - "children": [ - 93, - 94, - 95, - 96, - 97, - 98 - ] - } - ] + "flags": {} } ], "groups": [ @@ -1430,8 +403,8 @@ "children": [ 1, 15, - 30, - 92 + 19, + 22 ] } ]