@cparra/apexdocs 2.24.0 → 2.25.0-alpha.1

package/lib/model/markdown-generation-util/field-declaration-util.js

@@ -1,55 +1,54 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.declareField = void 0;
-function declareField(markdownFile, fields, startingHeadingLevel, grouped = false) {
-    markdownFile.addBlankLine();
-    fields.forEach((propertyModel) => {
-        addFieldSection(markdownFile, propertyModel, startingHeadingLevel, grouped);
-    });
-    markdownFile.addHorizontalRule();
-}
-exports.declareField = declareField;
-function addFieldSection(markdownFile, mirrorModel, startingHeadingLevel, grouped) {
-    var _a, _b, _c;
-    if (!grouped) {
-        markdownFile.addTitle(`\`${mirrorModel.access_modifier} ${mirrorModel.name}\` → \`${mirrorModel.typeReference.rawDeclaration}\``, startingHeadingLevel + 2);
-        markdownFile.addBlankLine();
-        if (mirrorModel.inherited) {
-            markdownFile.addText('*Inherited*');
-        }
-        mirrorModel.annotations.forEach((annotation) => {
-            markdownFile.addText(`\`${annotation.type.toUpperCase()}\` `);
-        });
-        if ((_a = mirrorModel.docComment) === null || _a === void 0 ? void 0 : _a.description) {
-            markdownFile.addBlankLine();
-            markdownFile.addText(mirrorModel.docComment.description);
-        }
-        markdownFile.addBlankLine();
-    }
-    else {
-        let annotations = '';
-        const hasAnnotations = !!mirrorModel.annotations.length;
-        if (hasAnnotations) {
-            annotations += ' [';
-        }
-        mirrorModel.annotations.forEach((annotation) => {
-            annotations += `\`${annotation.type.toUpperCase()}\` `;
-        });
-        if (hasAnnotations) {
-            annotations += ']';
-        }
-        // If grouped we want to display these as a list
-        let description = '';
-        if ((_b = mirrorModel.docComment) === null || _b === void 0 ? void 0 : _b.description) {
-            description = ` - ${(_c = mirrorModel.docComment) === null || _c === void 0 ? void 0 : _c.description}`;
-        }
-        let listItemText = `\`${mirrorModel.access_modifier} ${mirrorModel.name}\` → \`${mirrorModel.typeReference.rawDeclaration}\``;
-        if (mirrorModel.inherited) {
-            listItemText += '(*Inherited*)';
-        }
-        listItemText += `${annotations} ${description}`;
-        markdownFile.addListItem(listItemText);
-        markdownFile.addBlankLine();
-    }
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.declareField = declareField;
+function declareField(markdownFile, fields, startingHeadingLevel, grouped = false) {
+    markdownFile.addBlankLine();
+    fields.forEach((propertyModel) => {
+        addFieldSection(markdownFile, propertyModel, startingHeadingLevel, grouped);
+    });
+    markdownFile.addHorizontalRule();
+}
+function addFieldSection(markdownFile, mirrorModel, startingHeadingLevel, grouped) {
+    var _a, _b, _c;
+    if (!grouped) {
+        markdownFile.addTitle(`\`${mirrorModel.access_modifier} ${mirrorModel.name}\` → \`${mirrorModel.typeReference.rawDeclaration}\``, startingHeadingLevel + 2);
+        markdownFile.addBlankLine();
+        if (mirrorModel.inherited) {
+            markdownFile.addText('*Inherited*');
+        }
+        mirrorModel.annotations.forEach((annotation) => {
+            markdownFile.addText(`\`${annotation.type.toUpperCase()}\` `);
+        });
+        if ((_a = mirrorModel.docComment) === null || _a === void 0 ? void 0 : _a.description) {
+            markdownFile.addBlankLine();
+            markdownFile.addText(mirrorModel.docComment.description);
+        }
+        markdownFile.addBlankLine();
+    }
+    else {
+        let annotations = '';
+        const hasAnnotations = !!mirrorModel.annotations.length;
+        if (hasAnnotations) {
+            annotations += ' [';
+        }
+        mirrorModel.annotations.forEach((annotation) => {
+            annotations += `\`${annotation.type.toUpperCase()}\` `;
+        });
+        if (hasAnnotations) {
+            annotations += ']';
+        }
+        // If grouped we want to display these as a list
+        let description = '';
+        if ((_b = mirrorModel.docComment) === null || _b === void 0 ? void 0 : _b.description) {
+            description = ` - ${(_c = mirrorModel.docComment) === null || _c === void 0 ? void 0 : _c.description}`;
+        }
+        let listItemText = `\`${mirrorModel.access_modifier} ${mirrorModel.name}\` → \`${mirrorModel.typeReference.rawDeclaration}\``;
+        if (mirrorModel.inherited) {
+            listItemText += '(*Inherited*)';
+        }
+        listItemText += `${annotations} ${description}`;
+        markdownFile.addListItem(listItemText);
+        markdownFile.addBlankLine();
+    }
+}
 //# sourceMappingURL=field-declaration-util.js.map

package/lib/model/markdown-generation-util/field-declaration-util.js.map

@@ -1 +1 @@
-{"version":3,"file":"field-declaration-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/field-declaration-util.ts"],"names":[],"mappings":";;;AAGA,SAAgB,YAAY,CAC1B,YAA0B,EAC1B,MAAsE,EACtE,oBAA4B,EAC5B,OAAO,GAAG,KAAK;IAEf,YAAY,CAAC,YAAY,EAAE,CAAC;IAC5B,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;QAC/B,eAAe,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,iBAAiB,EAAE,CAAC;AACnC,CAAC;AAZD,oCAYC;AAED,SAAS,eAAe,CACtB,YAA0B,EAC1B,WAA4B,EAC5B,oBAA4B,EAC5B,OAAgB;;IAEhB,IAAI,CAAC,OAAO,EAAE;QACZ,YAAY,CAAC,QAAQ,CACnB,KAAK,WAAW,CAAC,eAAe,IAAI,WAAW,CAAC,IAAI,UAAU,WAAW,CAAC,aAAa,CAAC,cAAc,IAAI,EAC1G,oBAAoB,GAAG,CAAC,CACzB,CAAC;QACF,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,IAAI,WAAW,CAAC,SAAS,EAAE;YACzB,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SACrC;QAED,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC7C,YAAY,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,IAAI,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,EAAE;YACvC,YAAY,CAAC,YAAY,EAAE,CAAC;YAC5B,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;SAC1D;QACD,YAAY,CAAC,YAAY,EAAE,CAAC;KAC7B;SAAM;QACL,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC;QACxD,IAAI,cAAc,EAAE;YAClB,WAAW,IAAI,IAAI,CAAC;SACrB;QACD,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC7C,WAAW,IAAI,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC;QACzD,CAAC,CAAC,CAAC;QACH,IAAI,cAAc,EAAE;YAClB,WAAW,IAAI,GAAG,CAAC;SACpB;QAED,gDAAgD;QAChD,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,IAAI,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,EAAE;YACvC,WAAW,GAAG,MAAM,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,EAAE,CAAC;SAC3D;QAED,IAAI,YAAY,GAAG,KAAK,WAAW,CAAC,eAAe,IAAI,WAAW,CAAC,IAAI,UAAU,WAAW,CAAC,aAAa,CAAC,cAAc,IAAI,CAAC;QAC9H,IAAI,WAAW,CAAC,SAAS,EAAE;YACzB,YAAY,IAAI,eAAe,CAAC;SACjC;QACD,YAAY,IAAI,GAAG,WAAW,IAAI,WAAW,EAAE,CAAC;QAEhD,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACvC,YAAY,CAAC,YAAY,EAAE,CAAC;KAC7B;AACH,CAAC"}
+{"version":3,"file":"field-declaration-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/field-declaration-util.ts"],"names":[],"mappings":";;AAGA,oCAYC;AAZD,SAAgB,YAAY,CAC1B,YAA0B,EAC1B,MAAsE,EACtE,oBAA4B,EAC5B,OAAO,GAAG,KAAK;IAEf,YAAY,CAAC,YAAY,EAAE,CAAC;IAC5B,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;QAC/B,eAAe,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,iBAAiB,EAAE,CAAC;AACnC,CAAC;AAED,SAAS,eAAe,CACtB,YAA0B,EAC1B,WAA4B,EAC5B,oBAA4B,EAC5B,OAAgB;;IAEhB,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,YAAY,CAAC,QAAQ,CACnB,KAAK,WAAW,CAAC,eAAe,IAAI,WAAW,CAAC,IAAI,UAAU,WAAW,CAAC,aAAa,CAAC,cAAc,IAAI,EAC1G,oBAAoB,GAAG,CAAC,CACzB,CAAC;QACF,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC;YAC1B,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACtC,CAAC;QAED,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC7C,YAAY,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,IAAI,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,EAAE,CAAC;YACxC,YAAY,CAAC,YAAY,EAAE,CAAC;YAC5B,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,CAAC;QACD,YAAY,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC;SAAM,CAAC;QACN,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC;QACxD,IAAI,cAAc,EAAE,CAAC;YACnB,WAAW,IAAI,IAAI,CAAC;QACtB,CAAC;QACD,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC7C,WAAW,IAAI,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC;QACzD,CAAC,CAAC,CAAC;QACH,IAAI,cAAc,EAAE,CAAC;YACnB,WAAW,IAAI,GAAG,CAAC;QACrB,CAAC;QAED,gDAAgD;QAChD,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,IAAI,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,EAAE,CAAC;YACxC,WAAW,GAAG,MAAM,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,EAAE,CAAC;QAC5D,CAAC;QAED,IAAI,YAAY,GAAG,KAAK,WAAW,CAAC,eAAe,IAAI,WAAW,CAAC,IAAI,UAAU,WAAW,CAAC,aAAa,CAAC,cAAc,IAAI,CAAC;QAC9H,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC;YAC1B,YAAY,IAAI,eAAe,CAAC;QAClC,CAAC;QACD,YAAY,IAAI,GAAG,WAAW,IAAI,WAAW,EAAE,CAAC;QAEhD,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACvC,YAAY,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC;AACH,CAAC"}

package/lib/model/markdown-generation-util/index.d.ts

@@ -1,3 +1,3 @@
-export * from './type-declaration-util';
-export * from './method-declaration-util';
-export * from './field-declaration-util';
+export * from './type-declaration-util';
+export * from './method-declaration-util';
+export * from './field-declaration-util';

package/lib/model/markdown-generation-util/index.js

@@ -1,20 +1,20 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./type-declaration-util"), exports);
-__exportStar(require("./method-declaration-util"), exports);
-__exportStar(require("./field-declaration-util"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./type-declaration-util"), exports);
+__exportStar(require("./method-declaration-util"), exports);
+__exportStar(require("./field-declaration-util"), exports);
 //# sourceMappingURL=index.js.map

package/lib/model/markdown-generation-util/method-declaration-util.d.ts

@@ -1,4 +1,4 @@
-import { ConstructorMirror } from '@cparra/apex-reflection';
-import { MarkdownFile } from '../markdown-file';
-import { MethodMirrorWithInheritance } from '../inheritance';
-export declare function declareMethod(markdownFile: MarkdownFile, methods: ConstructorMirror[] | MethodMirrorWithInheritance[], startingHeadingLevel: number, className?: string): void;
+import { ConstructorMirror } from '@cparra/apex-reflection';
+import { MarkdownFile } from '../markdown-file';
+import { MethodMirrorWithInheritance } from '../inheritance';
+export declare function declareMethod(markdownFile: MarkdownFile, methods: ConstructorMirror[] | MethodMirrorWithInheritance[], startingHeadingLevel: number, className?: string): void;

package/lib/model/markdown-generation-util/method-declaration-util.js

@@ -1,115 +1,114 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.declareMethod = void 0;
-const doc_comment_annotation_util_1 = require("./doc-comment-annotation-util");
-function declareMethod(markdownFile, methods, startingHeadingLevel, className = '') {
-    methods.forEach((currentMethod) => {
-        var _a, _b;
-        const signatureName = isMethod(currentMethod)
-            ? `${currentMethod.typeReference.rawDeclaration} ${currentMethod.name}`
-            : className;
-        markdownFile.addTitle(`\`${buildSignature(currentMethod.access_modifier, signatureName, currentMethod)}\``, startingHeadingLevel + 2);
-        // Inheritance tag
-        if (isMethod(currentMethod)) {
-            const asMethodMirror = currentMethod;
-            if (asMethodMirror.inherited) {
-                markdownFile.addBlankLine();
-                markdownFile.addText('*Inherited*');
-                markdownFile.addBlankLine();
-            }
-        }
-        currentMethod.annotations.forEach((annotation) => {
-            markdownFile.addBlankLine();
-            markdownFile.addText(`\`${annotation.type.toUpperCase()}\``);
-        });
-        if ((_a = currentMethod.docComment) === null || _a === void 0 ? void 0 : _a.description) {
-            markdownFile.addBlankLine();
-            markdownFile.addText(currentMethod.docComment.description);
-            markdownFile.addBlankLine();
-        }
-        if (currentMethod.parameters.length) {
-            addParameters(markdownFile, currentMethod, startingHeadingLevel);
-        }
-        if (isMethod(currentMethod)) {
-            addReturns(markdownFile, currentMethod, startingHeadingLevel);
-        }
-        addThrowsBlock(markdownFile, currentMethod, startingHeadingLevel);
-        (0, doc_comment_annotation_util_1.addCustomDocCommentAnnotations)(markdownFile, currentMethod);
-        (0, doc_comment_annotation_util_1.addMermaid)(markdownFile, currentMethod);
-        if ((_b = currentMethod.docComment) === null || _b === void 0 ? void 0 : _b.exampleAnnotation) {
-            addExample(markdownFile, currentMethod, startingHeadingLevel);
-        }
-    });
-    markdownFile.addHorizontalRule();
-}
-exports.declareMethod = declareMethod;
-function buildSignature(accessModifier, name, parameterAware) {
-    let signature = `${name}(`;
-    if (isMethod(parameterAware) && parameterAware.memberModifiers.length) {
-        signature =
-            accessModifier +
-                ' ' +
-                parameterAware.memberModifiers.join(' ') +
-                ' ' +
-                signature;
-    }
-    else {
-        signature = accessModifier + ' ' + signature;
-    }
-    const signatureParameters = parameterAware.parameters.map((param) => `${param.typeReference.rawDeclaration} ${param.name}`);
-    signature += signatureParameters.join(', ');
-    return `${signature})`;
-}
-function addParameters(markdownFile, methodModel, startingHeadingLevel) {
-    var _a, _b;
-    if (!((_a = methodModel.docComment) === null || _a === void 0 ? void 0 : _a.paramAnnotations.length)) {
-        // If there are no parameters defined in the docs then we don't want to display this section
-        return;
-    }
-    markdownFile.addTitle('Parameters', startingHeadingLevel + 3);
-    markdownFile.initializeTable('Param', 'Description');
-    (_b = methodModel.docComment) === null || _b === void 0 ? void 0 : _b.paramAnnotations.forEach((paramAnnotation) => {
-        const paramName = paramAnnotation.paramName;
-        const paramDescription = paramAnnotation.bodyLines.join(' ');
-        markdownFile.addTableRow(`\`${paramName}\``, paramDescription);
-    });
-    markdownFile.addBlankLine();
-}
-function addReturns(markdownFile, methodModel, startingHeadingLevel) {
-    var _a, _b;
-    if (!((_a = methodModel.docComment) === null || _a === void 0 ? void 0 : _a.returnAnnotation)) {
-        return;
-    }
-    markdownFile.addTitle('Returns', startingHeadingLevel + 3);
-    markdownFile.initializeTable('Type', 'Description');
-    markdownFile.addTableRow(`\`${methodModel.typeReference.rawDeclaration}\``, (_b = methodModel.docComment) === null || _b === void 0 ? void 0 : _b.returnAnnotation.bodyLines.join(' '));
-    markdownFile.addBlankLine();
-}
-function addThrowsBlock(markdownFile, docCommentAware, startingHeadingLevel) {
-    var _a, _b;
-    if (!((_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.throwsAnnotations.length)) {
-        return;
-    }
-    markdownFile.addTitle('Throws', startingHeadingLevel + 3);
-    markdownFile.initializeTable('Exception', 'Description');
-    (_b = docCommentAware.docComment) === null || _b === void 0 ? void 0 : _b.throwsAnnotations.forEach((annotation) => {
-        const exceptionName = annotation.exceptionName;
-        const exceptionDescription = annotation.bodyLines.join(' ');
-        markdownFile.addTableRow(`\`${exceptionName}\``, exceptionDescription);
-    });
-    markdownFile.addBlankLine();
-}
-function addExample(markdownFile, docCommentAware, startingHeadingLevel) {
-    var _a;
-    markdownFile.addTitle('Example', startingHeadingLevel + 3);
-    markdownFile.startCodeBlock();
-    (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.exampleAnnotation.bodyLines.forEach((line) => {
-        markdownFile.addText(line, false);
-    });
-    markdownFile.endCodeBlock();
-    markdownFile.addBlankLine();
-}
-function isMethod(method) {
-    return method.typeReference !== undefined;
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.declareMethod = declareMethod;
+const doc_comment_annotation_util_1 = require("./doc-comment-annotation-util");
+function declareMethod(markdownFile, methods, startingHeadingLevel, className = '') {
+    methods.forEach((currentMethod) => {
+        var _a, _b;
+        const signatureName = isMethod(currentMethod)
+            ? `${currentMethod.typeReference.rawDeclaration} ${currentMethod.name}`
+            : className;
+        markdownFile.addTitle(`\`${buildSignature(currentMethod.access_modifier, signatureName, currentMethod)}\``, startingHeadingLevel + 2);
+        // Inheritance tag
+        if (isMethod(currentMethod)) {
+            const asMethodMirror = currentMethod;
+            if (asMethodMirror.inherited) {
+                markdownFile.addBlankLine();
+                markdownFile.addText('*Inherited*');
+                markdownFile.addBlankLine();
+            }
+        }
+        currentMethod.annotations.forEach((annotation) => {
+            markdownFile.addBlankLine();
+            markdownFile.addText(`\`${annotation.type.toUpperCase()}\``);
+        });
+        if ((_a = currentMethod.docComment) === null || _a === void 0 ? void 0 : _a.description) {
+            markdownFile.addBlankLine();
+            markdownFile.addText(currentMethod.docComment.description);
+            markdownFile.addBlankLine();
+        }
+        if (currentMethod.parameters.length) {
+            addParameters(markdownFile, currentMethod, startingHeadingLevel);
+        }
+        if (isMethod(currentMethod)) {
+            addReturns(markdownFile, currentMethod, startingHeadingLevel);
+        }
+        addThrowsBlock(markdownFile, currentMethod, startingHeadingLevel);
+        (0, doc_comment_annotation_util_1.addCustomDocCommentAnnotations)(markdownFile, currentMethod);
+        (0, doc_comment_annotation_util_1.addMermaid)(markdownFile, currentMethod);
+        if ((_b = currentMethod.docComment) === null || _b === void 0 ? void 0 : _b.exampleAnnotation) {
+            addExample(markdownFile, currentMethod, startingHeadingLevel);
+        }
+    });
+    markdownFile.addHorizontalRule();
+}
+function buildSignature(accessModifier, name, parameterAware) {
+    let signature = `${name}(`;
+    if (isMethod(parameterAware) && parameterAware.memberModifiers.length) {
+        signature =
+            accessModifier +
+                ' ' +
+                parameterAware.memberModifiers.join(' ') +
+                ' ' +
+                signature;
+    }
+    else {
+        signature = accessModifier + ' ' + signature;
+    }
+    const signatureParameters = parameterAware.parameters.map((param) => `${param.typeReference.rawDeclaration} ${param.name}`);
+    signature += signatureParameters.join(', ');
+    return `${signature})`;
+}
+function addParameters(markdownFile, methodModel, startingHeadingLevel) {
+    var _a, _b;
+    if (!((_a = methodModel.docComment) === null || _a === void 0 ? void 0 : _a.paramAnnotations.length)) {
+        // If there are no parameters defined in the docs then we don't want to display this section
+        return;
+    }
+    markdownFile.addTitle('Parameters', startingHeadingLevel + 3);
+    markdownFile.initializeTable('Param', 'Description');
+    (_b = methodModel.docComment) === null || _b === void 0 ? void 0 : _b.paramAnnotations.forEach((paramAnnotation) => {
+        const paramName = paramAnnotation.paramName;
+        const paramDescription = paramAnnotation.bodyLines.join(' ');
+        markdownFile.addTableRow(`\`${paramName}\``, paramDescription);
+    });
+    markdownFile.addBlankLine();
+}
+function addReturns(markdownFile, methodModel, startingHeadingLevel) {
+    var _a, _b;
+    if (!((_a = methodModel.docComment) === null || _a === void 0 ? void 0 : _a.returnAnnotation)) {
+        return;
+    }
+    markdownFile.addTitle('Returns', startingHeadingLevel + 3);
+    markdownFile.initializeTable('Type', 'Description');
+    markdownFile.addTableRow(`\`${methodModel.typeReference.rawDeclaration}\``, (_b = methodModel.docComment) === null || _b === void 0 ? void 0 : _b.returnAnnotation.bodyLines.join(' '));
+    markdownFile.addBlankLine();
+}
+function addThrowsBlock(markdownFile, docCommentAware, startingHeadingLevel) {
+    var _a, _b;
+    if (!((_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.throwsAnnotations.length)) {
+        return;
+    }
+    markdownFile.addTitle('Throws', startingHeadingLevel + 3);
+    markdownFile.initializeTable('Exception', 'Description');
+    (_b = docCommentAware.docComment) === null || _b === void 0 ? void 0 : _b.throwsAnnotations.forEach((annotation) => {
+        const exceptionName = annotation.exceptionName;
+        const exceptionDescription = annotation.bodyLines.join(' ');
+        markdownFile.addTableRow(`\`${exceptionName}\``, exceptionDescription);
+    });
+    markdownFile.addBlankLine();
+}
+function addExample(markdownFile, docCommentAware, startingHeadingLevel) {
+    var _a;
+    markdownFile.addTitle('Example', startingHeadingLevel + 3);
+    markdownFile.startCodeBlock();
+    (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.exampleAnnotation.bodyLines.forEach((line) => {
+        markdownFile.addText(line);
+    });
+    markdownFile.endCodeBlock();
+    markdownFile.addBlankLine();
+}
+function isMethod(method) {
+    return method.typeReference !== undefined;
+}
 //# sourceMappingURL=method-declaration-util.js.map

package/lib/model/markdown-generation-util/method-declaration-util.js.map

@@ -1 +1 @@
-{"version":3,"file":"method-declaration-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/method-declaration-util.ts"],"names":[],"mappings":";;;AAGA,+EAA2F;AAG3F,SAAgB,aAAa,CAC3B,YAA0B,EAC1B,OAA4D,EAC5D,oBAA4B,EAC5B,SAAS,GAAG,EAAE;IAEd,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;QAChC,MAAM,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC;YAC3C,CAAC,CAAC,GAAI,aAA6C,CAAC,aAAa,CAAC,cAAc,IAC3E,aAA6C,CAAC,IACjD,EAAE;YACJ,CAAC,CAAC,SAAS,CAAC;QAEd,YAAY,CAAC,QAAQ,CACnB,KAAK,cAAc,CAAC,aAAa,CAAC,eAAe,EAAE,aAAa,EAAE,aAAa,CAAC,IAAI,EACpF,oBAAoB,GAAG,CAAC,CACzB,CAAC;QAEF,kBAAkB;QAClB,IAAI,QAAQ,CAAC,aAAa,CAAC,EAAE;YAC3B,MAAM,cAAc,GAAG,aAA4C,CAAC;YACpE,IAAI,cAAc,CAAC,SAAS,EAAE;gBAC5B,YAAY,CAAC,YAAY,EAAE,CAAC;gBAC5B,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;gBACpC,YAAY,CAAC,YAAY,EAAE,CAAC;aAC7B;SACF;QAED,aAAa,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC/C,YAAY,CAAC,YAAY,EAAE,CAAC;YAC5B,YAAY,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QAEH,IAAI,MAAA,aAAa,CAAC,UAAU,0CAAE,WAAW,EAAE;YACzC,YAAY,CAAC,YAAY,EAAE,CAAC;YAC5B,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YAC3D,YAAY,CAAC,YAAY,EAAE,CAAC;SAC7B;QAED,IAAI,aAAa,CAAC,UAAU,CAAC,MAAM,EAAE;YACnC,aAAa,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;SAClE;QAED,IAAI,QAAQ,CAAC,aAAa,CAAC,EAAE;YAC3B,UAAU,CAAC,YAAY,EAAE,aAA4C,EAAE,oBAAoB,CAAC,CAAC;SAC9F;QAED,cAAc,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;QAElE,IAAA,4DAA8B,EAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QAE5D,IAAA,wCAAU,EAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QAExC,IAAI,MAAA,aAAa,CAAC,UAAU,0CAAE,iBAAiB,EAAE;YAC/C,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;SAC/D;IACH,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,iBAAiB,EAAE,CAAC;AACnC,CAAC;AA3DD,sCA2DC;AAUD,SAAS,cAAc,CAAC,cAAsB,EAAE,IAAY,EAAE,cAA8B;IAC1F,IAAI,SAAS,GAAG,GAAG,IAAI,GAAG,CAAC;IAC3B,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAK,cAA8C,CAAC,eAAe,CAAC,MAAM,EAAE;QACtG,SAAS;YACP,cAAc;gBACd,GAAG;gBACF,cAA8C,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC;gBACzE,GAAG;gBACH,SAAS,CAAC;KACb;SAAM;QACL,SAAS,GAAG,cAAc,GAAG,GAAG,GAAG,SAAS,CAAC;KAC9C;IACD,MAAM,mBAAmB,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,CACvD,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CACjE,CAAC;IACF,SAAS,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,OAAO,GAAG,SAAS,GAAG,CAAC;AACzB,CAAC;AAED,SAAS,aAAa,CACpB,YAA0B,EAC1B,WAA4D,EAC5D,oBAA4B;;IAE5B,IAAI,CAAC,CAAA,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,MAAM,CAAA,EAAE;QACpD,4FAA4F;QAC5F,OAAO;KACR;IAED,YAAY,CAAC,QAAQ,CAAC,YAAY,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC9D,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAErD,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;QACnE,MAAM,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC;QAC5C,MAAM,gBAAgB,GAAG,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7D,YAAY,CAAC,WAAW,CAAC,KAAK,SAAS,IAAI,EAAE,gBAAgB,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,UAAU,CACjB,YAA0B,EAC1B,WAAwC,EACxC,oBAA4B;;IAE5B,IAAI,CAAC,CAAA,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAA,EAAE;QAC7C,OAAO;KACR;IAED,YAAY,CAAC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC3D,YAAY,CAAC,eAAe,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACpD,YAAY,CAAC,WAAW,CACtB,KAAK,WAAW,CAAC,aAAa,CAAC,cAAc,IAAI,EACjD,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAC7D,CAAC;IACF,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,cAAc,CAAC,YAA0B,EAAE,eAAgC,EAAE,oBAA4B;;IAChH,IAAI,CAAC,CAAA,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,MAAM,CAAA,EAAE;QACzD,OAAO;KACR;IACD,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC1D,YAAY,CAAC,eAAe,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAEzD,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QACnE,MAAM,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;QAC/C,MAAM,oBAAoB,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE5D,YAAY,CAAC,WAAW,CAAC,KAAK,aAAa,IAAI,EAAE,oBAAoB,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,UAAU,CAAC,YAA0B,EAAE,eAAgC,EAAE,oBAA4B;;IAC5G,YAAY,CAAC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC3D,YAAY,CAAC,cAAc,EAAE,CAAC;IAC9B,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACvE,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IACH,YAAY,CAAC,YAAY,EAAE,CAAC;IAC5B,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,QAAQ,CACf,MAAwE;IAExE,OAAQ,MAAsC,CAAC,aAAa,KAAK,SAAS,CAAC;AAC7E,CAAC"}
+{"version":3,"file":"method-declaration-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/method-declaration-util.ts"],"names":[],"mappings":";;AAMA,sCA2DC;AA9DD,+EAA2F;AAG3F,SAAgB,aAAa,CAC3B,YAA0B,EAC1B,OAA4D,EAC5D,oBAA4B,EAC5B,SAAS,GAAG,EAAE;IAEd,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;QAChC,MAAM,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC;YAC3C,CAAC,CAAC,GAAI,aAA6C,CAAC,aAAa,CAAC,cAAc,IAC3E,aAA6C,CAAC,IACjD,EAAE;YACJ,CAAC,CAAC,SAAS,CAAC;QAEd,YAAY,CAAC,QAAQ,CACnB,KAAK,cAAc,CAAC,aAAa,CAAC,eAAe,EAAE,aAAa,EAAE,aAAa,CAAC,IAAI,EACpF,oBAAoB,GAAG,CAAC,CACzB,CAAC;QAEF,kBAAkB;QAClB,IAAI,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YAC5B,MAAM,cAAc,GAAG,aAA4C,CAAC;YACpE,IAAI,cAAc,CAAC,SAAS,EAAE,CAAC;gBAC7B,YAAY,CAAC,YAAY,EAAE,CAAC;gBAC5B,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;gBACpC,YAAY,CAAC,YAAY,EAAE,CAAC;YAC9B,CAAC;QACH,CAAC;QAED,aAAa,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC/C,YAAY,CAAC,YAAY,EAAE,CAAC;YAC5B,YAAY,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QAEH,IAAI,MAAA,aAAa,CAAC,UAAU,0CAAE,WAAW,EAAE,CAAC;YAC1C,YAAY,CAAC,YAAY,EAAE,CAAC;YAC5B,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YAC3D,YAAY,CAAC,YAAY,EAAE,CAAC;QAC9B,CAAC;QAED,IAAI,aAAa,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACpC,aAAa,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YAC5B,UAAU,CAAC,YAAY,EAAE,aAA4C,EAAE,oBAAoB,CAAC,CAAC;QAC/F,CAAC;QAED,cAAc,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;QAElE,IAAA,4DAA8B,EAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QAE5D,IAAA,wCAAU,EAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QAExC,IAAI,MAAA,aAAa,CAAC,UAAU,0CAAE,iBAAiB,EAAE,CAAC;YAChD,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;QAChE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,iBAAiB,EAAE,CAAC;AACnC,CAAC;AAUD,SAAS,cAAc,CAAC,cAAsB,EAAE,IAAY,EAAE,cAA8B;IAC1F,IAAI,SAAS,GAAG,GAAG,IAAI,GAAG,CAAC;IAC3B,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAK,cAA8C,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;QACvG,SAAS;YACP,cAAc;gBACd,GAAG;gBACF,cAA8C,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC;gBACzE,GAAG;gBACH,SAAS,CAAC;IACd,CAAC;SAAM,CAAC;QACN,SAAS,GAAG,cAAc,GAAG,GAAG,GAAG,SAAS,CAAC;IAC/C,CAAC;IACD,MAAM,mBAAmB,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,CACvD,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CACjE,CAAC;IACF,SAAS,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,OAAO,GAAG,SAAS,GAAG,CAAC;AACzB,CAAC;AAED,SAAS,aAAa,CACpB,YAA0B,EAC1B,WAA4D,EAC5D,oBAA4B;;IAE5B,IAAI,CAAC,CAAA,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,MAAM,CAAA,EAAE,CAAC;QACrD,4FAA4F;QAC5F,OAAO;IACT,CAAC;IAED,YAAY,CAAC,QAAQ,CAAC,YAAY,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC9D,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAErD,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;QACnE,MAAM,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC;QAC5C,MAAM,gBAAgB,GAAG,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7D,YAAY,CAAC,WAAW,CAAC,KAAK,SAAS,IAAI,EAAE,gBAAgB,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,UAAU,CACjB,YAA0B,EAC1B,WAAwC,EACxC,oBAA4B;;IAE5B,IAAI,CAAC,CAAA,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAA,EAAE,CAAC;QAC9C,OAAO;IACT,CAAC;IAED,YAAY,CAAC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC3D,YAAY,CAAC,eAAe,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACpD,YAAY,CAAC,WAAW,CACtB,KAAK,WAAW,CAAC,aAAa,CAAC,cAAc,IAAI,EACjD,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAC7D,CAAC;IACF,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,cAAc,CAAC,YAA0B,EAAE,eAAgC,EAAE,oBAA4B;;IAChH,IAAI,CAAC,CAAA,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,MAAM,CAAA,EAAE,CAAC;QAC1D,OAAO;IACT,CAAC;IACD,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC1D,YAAY,CAAC,eAAe,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAEzD,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QACnE,MAAM,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;QAC/C,MAAM,oBAAoB,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE5D,YAAY,CAAC,WAAW,CAAC,KAAK,aAAa,IAAI,EAAE,oBAAoB,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,UAAU,CAAC,YAA0B,EAAE,eAAgC,EAAE,oBAA4B;;IAC5G,YAAY,CAAC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC3D,YAAY,CAAC,cAAc,EAAE,CAAC;IAC9B,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACvE,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IACH,YAAY,CAAC,YAAY,EAAE,CAAC;IAC5B,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,QAAQ,CACf,MAAwE;IAExE,OAAQ,MAAsC,CAAC,aAAa,KAAK,SAAS,CAAC;AAC7E,CAAC"}

package/lib/model/markdown-generation-util/type-declaration-util.d.ts

@@ -1,3 +1,3 @@
-import { MarkdownFile } from '../markdown-file';
-import { Type } from '@cparra/apex-reflection';
-export declare function declareType(markdownFile: MarkdownFile, typeMirror: Type): void;
+import { MarkdownFile } from '../markdown-file';
+import { Type } from '@cparra/apex-reflection';
+export declare function declareType(markdownFile: MarkdownFile, typeMirror: Type): void;

package/lib/model/markdown-generation-util/type-declaration-util.js

@@ -1,82 +1,81 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.declareType = void 0;
-const doc_comment_annotation_util_1 = require("./doc-comment-annotation-util");
-const types_repository_1 = require("../types-repository");
-function declareType(markdownFile, typeMirror) {
-    var _a;
-    typeMirror.annotations.forEach((currentAnnotation) => {
-        markdownFile.addBlankLine();
-        markdownFile.addText(`\`${currentAnnotation.type.toUpperCase()}\``);
-    });
-    if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines) {
-        markdownFile.addBlankLine();
-        for (const currentLine of typeMirror.docComment.descriptionLines) {
-            markdownFile.addText(currentLine);
-        }
-        markdownFile.addBlankLine();
-    }
-    if (typeMirror.type_name === 'class') {
-        addInheritanceSectionForClass(typeMirror, markdownFile);
-    }
-    if (typeMirror.type_name === 'interface') {
-        addInheritanceSectionForInterface(typeMirror, markdownFile);
-    }
-    (0, doc_comment_annotation_util_1.addCustomDocCommentAnnotations)(markdownFile, typeMirror);
-    (0, doc_comment_annotation_util_1.addMermaid)(markdownFile, typeMirror);
-}
-exports.declareType = declareType;
-function addInheritanceSectionForClass(typeMirror, markdownFile) {
-    const typeAsClass = typeMirror;
-    if (typeAsClass.extended_class) {
-        markdownFile.addBlankLine();
-        markdownFile.addText('**Inheritance**');
-        markdownFile.addBlankLine();
-        addParent(markdownFile, typeAsClass);
-        markdownFile.addText(typeMirror.name);
-        markdownFile.addBlankLine();
-    }
-    if (typeAsClass.implemented_interfaces.length) {
-        markdownFile.addBlankLine();
-        markdownFile.addText('**Implemented types**');
-        markdownFile.addBlankLine();
-        for (let i = 0; i < typeAsClass.implemented_interfaces.length; i++) {
-            const currentName = typeAsClass.implemented_interfaces[i];
-            markdownFile.addLink(currentName);
-            if (i < typeAsClass.implemented_interfaces.length - 1) {
-                markdownFile.addText(', ');
-            }
-        }
-        markdownFile.addBlankLine();
-    }
-}
-function addInheritanceSectionForInterface(typeMirror, markdownFile) {
-    const typeAsInterface = typeMirror;
-    if (typeAsInterface.extended_interfaces.length) {
-        markdownFile.addBlankLine();
-        markdownFile.addText('**Extended types**');
-        markdownFile.addBlankLine();
-        for (let i = 0; i < typeAsInterface.extended_interfaces.length; i++) {
-            const currentName = typeAsInterface.extended_interfaces[i];
-            markdownFile.addLink(currentName);
-            if (i < typeAsInterface.extended_interfaces.length - 1) {
-                markdownFile.addText(', ');
-            }
-        }
-    }
-}
-function addParent(markdownFile, classMirror) {
-    if (!classMirror.extended_class) {
-        return;
-    }
-    const parentType = types_repository_1.TypesRepository.getInstance().getFromScopedByName(classMirror.extended_class);
-    if (!parentType) {
-        return;
-    }
-    if (parentType.type_name === 'class') {
-        addParent(markdownFile, parentType);
-    }
-    markdownFile.addLink(parentType.name);
-    markdownFile.addText(' > ');
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.declareType = declareType;
+const doc_comment_annotation_util_1 = require("./doc-comment-annotation-util");
+const types_repository_1 = require("../types-repository");
+function declareType(markdownFile, typeMirror) {
+    var _a;
+    typeMirror.annotations.forEach((currentAnnotation) => {
+        markdownFile.addBlankLine();
+        markdownFile.addText(`\`${currentAnnotation.type.toUpperCase()}\``);
+    });
+    if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines) {
+        markdownFile.addBlankLine();
+        for (const currentLine of typeMirror.docComment.descriptionLines) {
+            markdownFile.addText(currentLine);
+        }
+        markdownFile.addBlankLine();
+    }
+    if (typeMirror.type_name === 'class') {
+        addInheritanceSectionForClass(typeMirror, markdownFile);
+    }
+    if (typeMirror.type_name === 'interface') {
+        addInheritanceSectionForInterface(typeMirror, markdownFile);
+    }
+    (0, doc_comment_annotation_util_1.addCustomDocCommentAnnotations)(markdownFile, typeMirror);
+    (0, doc_comment_annotation_util_1.addMermaid)(markdownFile, typeMirror);
+}
+function addInheritanceSectionForClass(typeMirror, markdownFile) {
+    const typeAsClass = typeMirror;
+    if (typeAsClass.extended_class) {
+        markdownFile.addBlankLine();
+        markdownFile.addText('**Inheritance**');
+        markdownFile.addBlankLine();
+        addParent(markdownFile, typeAsClass);
+        markdownFile.addText(typeMirror.name);
+        markdownFile.addBlankLine();
+    }
+    if (typeAsClass.implemented_interfaces.length) {
+        markdownFile.addBlankLine();
+        markdownFile.addText('**Implemented types**');
+        markdownFile.addBlankLine();
+        for (let i = 0; i < typeAsClass.implemented_interfaces.length; i++) {
+            const currentName = typeAsClass.implemented_interfaces[i];
+            markdownFile.addLink(currentName);
+            if (i < typeAsClass.implemented_interfaces.length - 1) {
+                markdownFile.addText(', ');
+            }
+        }
+        markdownFile.addBlankLine();
+    }
+}
+function addInheritanceSectionForInterface(typeMirror, markdownFile) {
+    const typeAsInterface = typeMirror;
+    if (typeAsInterface.extended_interfaces.length) {
+        markdownFile.addBlankLine();
+        markdownFile.addText('**Extended types**');
+        markdownFile.addBlankLine();
+        for (let i = 0; i < typeAsInterface.extended_interfaces.length; i++) {
+            const currentName = typeAsInterface.extended_interfaces[i];
+            markdownFile.addLink(currentName);
+            if (i < typeAsInterface.extended_interfaces.length - 1) {
+                markdownFile.addText(', ');
+            }
+        }
+    }
+}
+function addParent(markdownFile, classMirror) {
+    if (!classMirror.extended_class) {
+        return;
+    }
+    const parentType = types_repository_1.TypesRepository.getInstance().getFromScopedByName(classMirror.extended_class);
+    if (!parentType) {
+        return;
+    }
+    if (parentType.type_name === 'class') {
+        addParent(markdownFile, parentType);
+    }
+    markdownFile.addLink(parentType.name);
+    markdownFile.addText(' > ');
+}
 //# sourceMappingURL=type-declaration-util.js.map