@cparra/apexdocs 2.23.0-beta.0 → 2.23.0

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

@@ -1,82 +1,82 @@
-"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 = 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(' > ');
+}
 //# sourceMappingURL=type-declaration-util.js.map

package/lib/model/markdown-home-file.d.ts

@@ -1,11 +1,11 @@
-import { Type } from '@cparra/apex-reflection';
-import { MarkdownFile } from './markdown-file';
-export declare class MarkdownHomeFile extends MarkdownFile {
-    fileName: string;
-    types: Type[];
-    constructor(fileName: string, types: Type[], headerContent?: string);
-    private addTypeEntries;
-    private addTypeEntry;
-    private group;
-    private getClassGroup;
-}
+import { Type } from '@cparra/apex-reflection';
+import { MarkdownFile } from './markdown-file';
+export declare class MarkdownHomeFile extends MarkdownFile {
+    fileName: string;
+    types: Type[];
+    constructor(fileName: string, types: Type[], headerContent?: string);
+    private addTypeEntries;
+    private addTypeEntry;
+    private group;
+    private getClassGroup;
+}

package/lib/model/markdown-home-file.js

@@ -1,54 +1,54 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MarkdownHomeFile = void 0;
-const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
-const markdown_file_1 = require("./markdown-file");
-const string_utils_1 = require("../util/string-utils");
-const settings_1 = require("../settings");
-class MarkdownHomeFile extends markdown_file_1.MarkdownFile {
-    constructor(fileName, types, headerContent) {
-        super(fileName, '');
-        this.fileName = fileName;
-        this.types = types;
-        if (headerContent) {
-            this.addText(headerContent);
-        }
-        this.addTitle(settings_1.Settings.getInstance().getTitle());
-        this.addTypeEntries(types);
-    }
-    addTypeEntries(types) {
-        const groupedClasses = this.group(types);
-        groupedClasses.forEach((value, key) => {
-            this.addTitle(key, 2);
-            value.forEach((typeMirror) => {
-                this.addTypeEntry(typeMirror);
-            });
-        });
-    }
-    addTypeEntry(typeMirror) {
-        var _a;
-        this.addBlankLine();
-        this.addTitle(class_file_generatorHelper_1.default.getFileLink(typeMirror), 3);
-        this.addBlankLine();
-        if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines) {
-            const description = typeMirror.docComment.descriptionLines.reduce((previous, current) => previous + current + '\n', '');
-            this.addText((0, string_utils_1.truncate)(description, 300));
-            this.addBlankLine();
-        }
-    }
-    group(classes) {
-        return classes.reduce((groups, currentClass) => {
-            const key = this.getClassGroup(currentClass);
-            const group = groups.get(key) || [];
-            group.push(currentClass);
-            groups.set(key, group);
-            return groups;
-        }, new Map());
-    }
-    getClassGroup(classModel) {
-        var _a, _b, _c;
-        return ((_c = (_b = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'group')) === null || _b === void 0 ? void 0 : _b.body) !== null && _c !== void 0 ? _c : settings_1.Settings.getInstance().getDefaultGroupName());
-    }
-}
-exports.MarkdownHomeFile = MarkdownHomeFile;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownHomeFile = void 0;
+const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
+const markdown_file_1 = require("./markdown-file");
+const string_utils_1 = require("../util/string-utils");
+const settings_1 = require("../settings");
+class MarkdownHomeFile extends markdown_file_1.MarkdownFile {
+    constructor(fileName, types, headerContent) {
+        super(fileName, '');
+        this.fileName = fileName;
+        this.types = types;
+        if (headerContent) {
+            this.addText(headerContent);
+        }
+        this.addTitle(settings_1.Settings.getInstance().getTitle());
+        this.addTypeEntries(types);
+    }
+    addTypeEntries(types) {
+        const groupedClasses = this.group(types);
+        groupedClasses.forEach((value, key) => {
+            this.addTitle(key, 2);
+            value.forEach((typeMirror) => {
+                this.addTypeEntry(typeMirror);
+            });
+        });
+    }
+    addTypeEntry(typeMirror) {
+        var _a;
+        this.addBlankLine();
+        this.addTitle(class_file_generatorHelper_1.default.getFileLink(typeMirror), 3);
+        this.addBlankLine();
+        if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines) {
+            const description = typeMirror.docComment.descriptionLines.reduce((previous, current) => previous + current + '\n', '');
+            this.addText((0, string_utils_1.truncate)(description, 300));
+            this.addBlankLine();
+        }
+    }
+    group(classes) {
+        return classes.reduce((groups, currentClass) => {
+            const key = this.getClassGroup(currentClass);
+            const group = groups.get(key) || [];
+            group.push(currentClass);
+            groups.set(key, group);
+            return groups;
+        }, new Map());
+    }
+    getClassGroup(classModel) {
+        var _a, _b, _c;
+        return ((_c = (_b = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'group')) === null || _b === void 0 ? void 0 : _b.body) !== null && _c !== void 0 ? _c : settings_1.Settings.getInstance().getDefaultGroupName());
+    }
+}
+exports.MarkdownHomeFile = MarkdownHomeFile;
 //# sourceMappingURL=markdown-home-file.js.map

package/lib/model/markdown-type-file.d.ts

@@ -1,26 +1,26 @@
-import { ClassMirror, ConstructorMirror, EnumMirror, InterfaceMirror, MethodMirror, Type } from '@cparra/apex-reflection';
-import { WalkerListener } from '../service/walkers/walker';
-import { MarkdownFile } from './markdown-file';
-import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance } from './inheritance';
-export declare class MarkdownTypeFile extends MarkdownFile implements WalkerListener {
-    private type;
-    private headingLevel;
-    private isInner;
-    constructor(type: Type, headingLevel?: number, headerContent?: string, isInner?: boolean);
-    onTypeDeclaration(typeMirror: Type): void;
-    private isClass;
-    onConstructorDeclaration(className: string, constructors: ConstructorMirror[]): void;
-    onFieldsDeclaration(fields: FieldMirrorWithInheritance[]): void;
-    onPropertiesDeclaration(properties: PropertyMirrorWithInheritance[]): void;
-    onMethodsDeclaration(methods: MethodMirror[]): void;
-    onInnerEnumsDeclaration(enums: EnumMirror[]): void;
-    onInnerClassesDeclaration(classes: ClassMirror[]): void;
-    onInnerInterfacesDeclaration(interfaces: InterfaceMirror[]): void;
-    private addInnerTypes;
-    private hasGroupings;
-    private declareMethodWithGroupings;
-    private declareFieldOrProperty;
-    private startGroup;
-    private endGroup;
-    private group;
-}
+import { ClassMirror, ConstructorMirror, EnumMirror, InterfaceMirror, MethodMirror, Type } from '@cparra/apex-reflection';
+import { WalkerListener } from '../service/walkers/walker';
+import { MarkdownFile } from './markdown-file';
+import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance } from './inheritance';
+export declare class MarkdownTypeFile extends MarkdownFile implements WalkerListener {
+    private type;
+    private headingLevel;
+    private isInner;
+    constructor(type: Type, headingLevel?: number, headerContent?: string, isInner?: boolean);
+    onTypeDeclaration(typeMirror: Type): void;
+    private isClass;
+    onConstructorDeclaration(className: string, constructors: ConstructorMirror[]): void;
+    onFieldsDeclaration(fields: FieldMirrorWithInheritance[]): void;
+    onPropertiesDeclaration(properties: PropertyMirrorWithInheritance[]): void;
+    onMethodsDeclaration(methods: MethodMirror[]): void;
+    onInnerEnumsDeclaration(enums: EnumMirror[]): void;
+    onInnerClassesDeclaration(classes: ClassMirror[]): void;
+    onInnerInterfacesDeclaration(interfaces: InterfaceMirror[]): void;
+    private addInnerTypes;
+    private hasGroupings;
+    private declareMethodWithGroupings;
+    private declareFieldOrProperty;
+    private startGroup;
+    private endGroup;
+    private group;
+}

package/lib/model/markdown-type-file.js

@@ -1,134 +1,134 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MarkdownTypeFile = void 0;
-const walker_factory_1 = require("../service/walkers/walker-factory");
-const markdown_file_1 = require("./markdown-file");
-const markdown_generation_util_1 = require("./markdown-generation-util");
-const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
-const settings_1 = require("../settings");
-class MarkdownTypeFile extends markdown_file_1.MarkdownFile {
-    constructor(type, headingLevel = 1, headerContent, isInner = false) {
-        super(`${settings_1.Settings.getInstance().getNamespacePrefix()}${type.name}`, class_file_generatorHelper_1.default.getSanitizedGroup(type));
-        this.type = type;
-        this.headingLevel = headingLevel;
-        this.isInner = isInner;
-        if (headerContent) {
-            this.addText(headerContent);
-        }
-        const walker = walker_factory_1.WalkerFactory.get(type);
-        walker.walk(this);
-    }
-    onTypeDeclaration(typeMirror) {
-        let fullTypeName;
-        if (this.isInner) {
-            fullTypeName = typeMirror.name;
-        }
-        else {
-            // If we are dealing with a class, we want to check if it has a class
-            // modifier and add it to the name.
-            if (this.isClass(typeMirror) && typeMirror.classModifier) {
-                fullTypeName = `${typeMirror.classModifier} ${settings_1.Settings.getInstance().getNamespacePrefix()}${typeMirror.name}`;
-            }
-            else {
-                fullTypeName = `${settings_1.Settings.getInstance().getNamespacePrefix()}${typeMirror.name}`;
-            }
-        }
-        this.addTitle(fullTypeName, this.headingLevel);
-        (0, markdown_generation_util_1.declareType)(this, typeMirror);
-    }
-    isClass(typeMirror) {
-        return typeMirror.type_name === 'class';
-    }
-    onConstructorDeclaration(className, constructors) {
-        this.addTitle('Constructors', this.headingLevel + 1);
-        this.declareMethodWithGroupings(constructors, className);
-    }
-    onFieldsDeclaration(fields) {
-        this.addTitle('Fields', this.headingLevel + 1);
-        this.declareFieldOrProperty(fields);
-    }
-    onPropertiesDeclaration(properties) {
-        this.addTitle('Properties', this.headingLevel + 1);
-        this.declareFieldOrProperty(properties);
-    }
-    onMethodsDeclaration(methods) {
-        this.addTitle('Methods', this.headingLevel + 1);
-        this.declareMethodWithGroupings(methods);
-    }
-    onInnerEnumsDeclaration(enums) {
-        this.addInnerTypes('Enums', enums);
-    }
-    onInnerClassesDeclaration(classes) {
-        this.addInnerTypes('Classes', classes);
-    }
-    onInnerInterfacesDeclaration(interfaces) {
-        this.addInnerTypes('Interfaces', interfaces, false);
-    }
-    addInnerTypes(title, types, addSeparator = true) {
-        this.addTitle(title, this.headingLevel + 1);
-        types.forEach((currentType) => {
-            const innerFile = new MarkdownTypeFile(currentType, this.headingLevel + 2, undefined, true);
-            this.addText(innerFile._contents);
-        });
-        if (addSeparator) {
-            this.addHorizontalRule();
-        }
-    }
-    hasGroupings(groupAware) {
-        return !!groupAware.find((current) => !!current.group);
-    }
-    declareMethodWithGroupings(methods, className = '') {
-        const hasGroupings = this.hasGroupings(methods);
-        if (!hasGroupings) {
-            (0, markdown_generation_util_1.declareMethod)(this, methods, this.headingLevel, className);
-        }
-        else {
-            const groupedConstructors = this.group(methods);
-            for (const key in groupedConstructors) {
-                // For the group description, we can take the first one, since they all have the same description.
-                this.startGroup(key, groupedConstructors[key][0].groupDescription);
-                const constructorsForGroup = groupedConstructors[key];
-                (0, markdown_generation_util_1.declareMethod)(this, constructorsForGroup, this.headingLevel, className);
-                this.endGroup();
-            }
-        }
-    }
-    declareFieldOrProperty(fieldsOrProperties) {
-        const hasGroupings = this.hasGroupings(fieldsOrProperties);
-        if (!hasGroupings) {
-            (0, markdown_generation_util_1.declareField)(this, fieldsOrProperties, this.headingLevel, false);
-        }
-        else {
-            const groupedFields = this.group(fieldsOrProperties);
-            for (const key in groupedFields) {
-                // For the group description, we can take the first one, since they all have the same description.
-                this.startGroup(key, groupedFields[key][0].groupDescription);
-                const fieldsForGroup = groupedFields[key];
-                (0, markdown_generation_util_1.declareField)(this, fieldsForGroup, this.headingLevel, true);
-                this.endGroup();
-            }
-        }
-    }
-    startGroup(groupName, groupDescription) {
-        this.headingLevel = this.headingLevel + 2;
-        this.addTitle(groupName, this.headingLevel);
-        if (groupDescription) {
-            this.addText(groupDescription);
-        }
-    }
-    endGroup() {
-        this.headingLevel = this.headingLevel - 2;
-    }
-    group(list) {
-        return list.reduce((groups, item) => {
-            var _a;
-            const groupName = (_a = item.group) !== null && _a !== void 0 ? _a : 'Other';
-            const group = groups[groupName] || [];
-            group.push(item);
-            groups[groupName] = group;
-            return groups;
-        }, {});
-    }
-}
-exports.MarkdownTypeFile = MarkdownTypeFile;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownTypeFile = void 0;
+const walker_factory_1 = require("../service/walkers/walker-factory");
+const markdown_file_1 = require("./markdown-file");
+const markdown_generation_util_1 = require("./markdown-generation-util");
+const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
+const settings_1 = require("../settings");
+class MarkdownTypeFile extends markdown_file_1.MarkdownFile {
+    constructor(type, headingLevel = 1, headerContent, isInner = false) {
+        super(`${settings_1.Settings.getInstance().getNamespacePrefix()}${type.name}`, class_file_generatorHelper_1.default.getSanitizedGroup(type));
+        this.type = type;
+        this.headingLevel = headingLevel;
+        this.isInner = isInner;
+        if (headerContent) {
+            this.addText(headerContent);
+        }
+        const walker = walker_factory_1.WalkerFactory.get(type);
+        walker.walk(this);
+    }
+    onTypeDeclaration(typeMirror) {
+        let fullTypeName;
+        if (this.isInner) {
+            fullTypeName = typeMirror.name;
+        }
+        else {
+            // If we are dealing with a class, we want to check if it has a class
+            // modifier and add it to the name.
+            if (this.isClass(typeMirror) && typeMirror.classModifier) {
+                fullTypeName = `${typeMirror.classModifier} ${settings_1.Settings.getInstance().getNamespacePrefix()}${typeMirror.name}`;
+            }
+            else {
+                fullTypeName = `${settings_1.Settings.getInstance().getNamespacePrefix()}${typeMirror.name}`;
+            }
+        }
+        this.addTitle(fullTypeName, this.headingLevel);
+        (0, markdown_generation_util_1.declareType)(this, typeMirror);
+    }
+    isClass(typeMirror) {
+        return typeMirror.type_name === 'class';
+    }
+    onConstructorDeclaration(className, constructors) {
+        this.addTitle('Constructors', this.headingLevel + 1);
+        this.declareMethodWithGroupings(constructors, className);
+    }
+    onFieldsDeclaration(fields) {
+        this.addTitle('Fields', this.headingLevel + 1);
+        this.declareFieldOrProperty(fields);
+    }
+    onPropertiesDeclaration(properties) {
+        this.addTitle('Properties', this.headingLevel + 1);
+        this.declareFieldOrProperty(properties);
+    }
+    onMethodsDeclaration(methods) {
+        this.addTitle('Methods', this.headingLevel + 1);
+        this.declareMethodWithGroupings(methods);
+    }
+    onInnerEnumsDeclaration(enums) {
+        this.addInnerTypes('Enums', enums);
+    }
+    onInnerClassesDeclaration(classes) {
+        this.addInnerTypes('Classes', classes);
+    }
+    onInnerInterfacesDeclaration(interfaces) {
+        this.addInnerTypes('Interfaces', interfaces, false);
+    }
+    addInnerTypes(title, types, addSeparator = true) {
+        this.addTitle(title, this.headingLevel + 1);
+        types.forEach((currentType) => {
+            const innerFile = new MarkdownTypeFile(currentType, this.headingLevel + 2, undefined, true);
+            this.addText(innerFile._contents);
+        });
+        if (addSeparator) {
+            this.addHorizontalRule();
+        }
+    }
+    hasGroupings(groupAware) {
+        return !!groupAware.find((current) => !!current.group);
+    }
+    declareMethodWithGroupings(methods, className = '') {
+        const hasGroupings = this.hasGroupings(methods);
+        if (!hasGroupings) {
+            (0, markdown_generation_util_1.declareMethod)(this, methods, this.headingLevel, className);
+        }
+        else {
+            const groupedConstructors = this.group(methods);
+            for (const key in groupedConstructors) {
+                // For the group description, we can take the first one, since they all have the same description.
+                this.startGroup(key, groupedConstructors[key][0].groupDescription);
+                const constructorsForGroup = groupedConstructors[key];
+                (0, markdown_generation_util_1.declareMethod)(this, constructorsForGroup, this.headingLevel, className);
+                this.endGroup();
+            }
+        }
+    }
+    declareFieldOrProperty(fieldsOrProperties) {
+        const hasGroupings = this.hasGroupings(fieldsOrProperties);
+        if (!hasGroupings) {
+            (0, markdown_generation_util_1.declareField)(this, fieldsOrProperties, this.headingLevel, false);
+        }
+        else {
+            const groupedFields = this.group(fieldsOrProperties);
+            for (const key in groupedFields) {
+                // For the group description, we can take the first one, since they all have the same description.
+                this.startGroup(key, groupedFields[key][0].groupDescription);
+                const fieldsForGroup = groupedFields[key];
+                (0, markdown_generation_util_1.declareField)(this, fieldsForGroup, this.headingLevel, true);
+                this.endGroup();
+            }
+        }
+    }
+    startGroup(groupName, groupDescription) {
+        this.headingLevel = this.headingLevel + 2;
+        this.addTitle(groupName, this.headingLevel);
+        if (groupDescription) {
+            this.addText(groupDescription);
+        }
+    }
+    endGroup() {
+        this.headingLevel = this.headingLevel - 2;
+    }
+    group(list) {
+        return list.reduce((groups, item) => {
+            var _a;
+            const groupName = (_a = item.group) !== null && _a !== void 0 ? _a : 'Other';
+            const group = groups[groupName] || [];
+            group.push(item);
+            groups[groupName] = group;
+            return groups;
+        }, {});
+    }
+}
+exports.MarkdownTypeFile = MarkdownTypeFile;
 //# sourceMappingURL=markdown-type-file.js.map

package/lib/model/openapi/apex-doc-types.d.ts

@@ -1,19 +1,19 @@
-import { SchemaObjectArray, SchemaObjectObject } from './open-api-types';
-export type ApexDocHttpResponse = {
-    statusCode: number;
-    description?: string;
-    schema: ApexDocSchemaObject;
-};
-export type ApexDocHttpRequestBody = {
-    description?: string;
-    schema: ApexDocSchemaObject;
-    required?: boolean;
-};
-export type ApexDocParameterObject = {
-    name: string;
-    in: 'query' | 'header' | 'path' | 'cookie';
-    description?: string;
-    required?: boolean;
-    schema: ApexDocSchemaObject;
-};
-export type ApexDocSchemaObject = SchemaObjectObject | SchemaObjectArray | string;
+import { SchemaObjectArray, SchemaObjectObject } from './open-api-types';
+export type ApexDocHttpResponse = {
+    statusCode: number;
+    description?: string;
+    schema: ApexDocSchemaObject;
+};
+export type ApexDocHttpRequestBody = {
+    description?: string;
+    schema: ApexDocSchemaObject;
+    required?: boolean;
+};
+export type ApexDocParameterObject = {
+    name: string;
+    in: 'query' | 'header' | 'path' | 'cookie';
+    description?: string;
+    required?: boolean;
+    schema: ApexDocSchemaObject;
+};
+export type ApexDocSchemaObject = SchemaObjectObject | SchemaObjectArray | string;