@cparra/apexdocs 2.22.0 → 2.23.0

package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts

@@ -1,8 +1,8 @@
-import { DocComment } from '@cparra/apex-reflection';
-import { MarkdownFile } from '../markdown-file';
-interface DocCommentAware {
-    docComment?: DocComment;
-}
-export declare function addMermaid(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
-export declare function addCustomDocCommentAnnotations(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
-export {};
+import { DocComment } from '@cparra/apex-reflection';
+import { MarkdownFile } from '../markdown-file';
+interface DocCommentAware {
+    docComment?: DocComment;
+}
+export declare function addMermaid(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
+export declare function addCustomDocCommentAnnotations(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
+export {};

package/lib/model/markdown-generation-util/doc-comment-annotation-util.js

@@ -1,44 +1,44 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addCustomDocCommentAnnotations = exports.addMermaid = void 0;
-const class_file_generatorHelper_1 = require("../../transpiler/markdown/class-file-generatorHelper");
-function addMermaid(markdownFile, docCommentAware) {
-    var _a;
-    const mermaid = (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'mermaid');
-    if (!mermaid) {
-        return;
-    }
-    markdownFile.addBlankLine();
-    markdownFile.startCodeBlock('mermaid');
-    mermaid.bodyLines.forEach((line) => {
-        markdownFile.addText(line, false);
-    });
-    markdownFile.endCodeBlock();
-    markdownFile.addBlankLine();
-}
-exports.addMermaid = addMermaid;
-function addCustomDocCommentAnnotations(markdownFile, docCommentAware) {
-    var _a;
-    (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((currentAnnotation) => currentAnnotation.name !== 'description').filter((currentAnnotation) => currentAnnotation.name !== 'mermaid').forEach((currentAnnotation) => {
-        markdownFile.addBlankLine();
-        markdownFile.addText(buildDocAnnotationText(currentAnnotation));
-        markdownFile.addBlankLine();
-    });
-    function splitAndCapitalize(text) {
-        const words = text.split(/[-_]+/);
-        const capitalizedWords = [];
-        for (const word of words) {
-            capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
-        }
-        return capitalizedWords.join(' ');
-    }
-    function buildDocAnnotationText(annotation) {
-        let annotationBodyText = annotation.body;
-        if (annotation.name.toLowerCase() === 'see') {
-            annotationBodyText = class_file_generatorHelper_1.default.getFileLinkByTypeName(annotation.body);
-        }
-        return `**${splitAndCapitalize(annotation.name)}** ${annotationBodyText}`;
-    }
-}
-exports.addCustomDocCommentAnnotations = addCustomDocCommentAnnotations;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addCustomDocCommentAnnotations = exports.addMermaid = void 0;
+const class_file_generatorHelper_1 = require("../../transpiler/markdown/class-file-generatorHelper");
+function addMermaid(markdownFile, docCommentAware) {
+    var _a;
+    const mermaid = (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'mermaid');
+    if (!mermaid) {
+        return;
+    }
+    markdownFile.addBlankLine();
+    markdownFile.startCodeBlock('mermaid');
+    mermaid.bodyLines.forEach((line) => {
+        markdownFile.addText(line, false);
+    });
+    markdownFile.endCodeBlock();
+    markdownFile.addBlankLine();
+}
+exports.addMermaid = addMermaid;
+function addCustomDocCommentAnnotations(markdownFile, docCommentAware) {
+    var _a;
+    (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((currentAnnotation) => currentAnnotation.name !== 'description').filter((currentAnnotation) => currentAnnotation.name !== 'mermaid').forEach((currentAnnotation) => {
+        markdownFile.addBlankLine();
+        markdownFile.addText(buildDocAnnotationText(currentAnnotation));
+        markdownFile.addBlankLine();
+    });
+    function splitAndCapitalize(text) {
+        const words = text.split(/[-_]+/);
+        const capitalizedWords = [];
+        for (const word of words) {
+            capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
+        }
+        return capitalizedWords.join(' ');
+    }
+    function buildDocAnnotationText(annotation) {
+        let annotationBodyText = annotation.body;
+        if (annotation.name.toLowerCase() === 'see') {
+            annotationBodyText = class_file_generatorHelper_1.default.getFileLinkByTypeName(annotation.body);
+        }
+        return `**${splitAndCapitalize(annotation.name)}** ${annotationBodyText}`;
+    }
+}
+exports.addCustomDocCommentAnnotations = addCustomDocCommentAnnotations;
 //# sourceMappingURL=doc-comment-annotation-util.js.map

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

@@ -1,3 +1,3 @@
-import { MarkdownFile } from '../markdown-file';
-import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance } from '../inheritance';
-export declare function declareField(markdownFile: MarkdownFile, fields: FieldMirrorWithInheritance[] | PropertyMirrorWithInheritance[], startingHeadingLevel: number, grouped?: boolean): void;
+import { MarkdownFile } from '../markdown-file';
+import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance } from '../inheritance';
+export declare function declareField(markdownFile: MarkdownFile, fields: FieldMirrorWithInheritance[] | PropertyMirrorWithInheritance[], startingHeadingLevel: number, grouped?: boolean): void;

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

@@ -1,63 +1,55 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.declareField = void 0;
-function declareField(markdownFile, fields, startingHeadingLevel, grouped = false) {
-    markdownFile.addBlankLine();
-    fields
-        .sort((propA, propB) => {
-        if (propA.name < propB.name)
-            return -1;
-        if (propA.name > propB.name)
-            return 1;
-        return 0;
-    })
-        .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 = 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();
+    }
+}
 //# 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;SACH,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACrB,IAAI,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI;YAAE,OAAO,CAAC,CAAC,CAAC;QACvC,IAAI,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI;YAAE,OAAO,CAAC,CAAC;QACtC,OAAO,CAAC,CAAC;IACX,CAAC,CAAC;SACD,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;QACzB,eAAe,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEL,YAAY,CAAC,iBAAiB,EAAE,CAAC;AACnC,CAAC;AAlBD,oCAkBC;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,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"}

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,115 @@
-"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 = 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;
+}
 //# sourceMappingURL=method-declaration-util.js.map

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;