@cparra/apexdocs 2.25.0-alpha.0 → 2.25.0-alpha.1

package/lib/adapters/apex-types.js

@@ -1,34 +1,112 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.classTypeToClassSource = exports.interfaceTypeToInterfaceSource = exports.enumTypeToEnumSource = void 0;
+exports.typeToRenderableType = typeToRenderableType;
+exports.enumTypeToEnumSource = enumTypeToEnumSource;
+exports.interfaceTypeToInterfaceSource = interfaceTypeToInterfaceSource;
+exports.classTypeToClassSource = classTypeToClassSource;
 const documentables_1 = require("./documentables");
 const references_1 = require("./references");
 const methods_and_constructors_1 = require("./methods-and-constructors");
 const fields_and_properties_1 = require("./fields-and-properties");
-function baseTypeAdapter(type) {
-    function extractAnnotationBody(type, annotationName) {
-        var _a, _b;
-        return (_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((currentAnnotation) => currentAnnotation.name.toLowerCase() === annotationName)) === null || _b === void 0 ? void 0 : _b.body;
+function baseTypeAdapter(type, linkGenerator, baseHeadingLevel) {
+    function getHeading(type) {
+        const suffixMap = {
+            class: 'Class',
+            interface: 'Interface',
+            enum: 'Enum',
+        };
+        return `${type.name} ${suffixMap[type.type_name]}`;
     }
-    function extractSeeAnnotations(type) {
-        var _a, _b;
-        return ((_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((currentAnnotation) => currentAnnotation.name.toLowerCase() === 'see').map((currentAnnotation) => currentAnnotation.body)) !== null && _b !== void 0 ? _b : []);
+    return {
+        headingLevel: baseHeadingLevel,
+        heading: getHeading(type),
+        doc: (0, documentables_1.adaptDocumentable)(type, linkGenerator, baseHeadingLevel + 1),
+        name: type.name,
+        meta: {
+            accessModifier: type.access_modifier,
+        },
+    };
+}
+function typeToRenderableType(type, linkGenerator, namespace) {
+    function getRenderable() {
+        switch (type.type_name) {
+            case 'enum':
+                return enumTypeToEnumSource(type, linkGenerator);
+            case 'interface':
+                return interfaceTypeToInterfaceSource(type, linkGenerator);
+            case 'class':
+                return classTypeToClassSource(type, linkGenerator);
+        }
     }
-    return Object.assign(Object.assign({}, (0, documentables_1.adaptDocumentable)(type)), { accessModifier: type.access_modifier, name: type.name, group: extractAnnotationBody(type, 'group'), author: extractAnnotationBody(type, 'author'), date: extractAnnotationBody(type, 'date'), sees: extractSeeAnnotations(type).map(references_1.linkFromTypeNameGenerator) });
+    return Object.assign(Object.assign({}, getRenderable()), { namespace });
 }
-function enumTypeToEnumSource(enumType) {
-    return Object.assign(Object.assign({ __type: 'enum' }, baseTypeAdapter(enumType)), { values: enumType.values.map((value) => {
-            var _a;
-            return (Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)((_a = value.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines)), { value: value.name }));
-        }) });
+function enumTypeToEnumSource(enumType, linkGenerator, baseHeadingLevel = 1) {
+    return Object.assign(Object.assign({ type: 'enum' }, baseTypeAdapter(enumType, linkGenerator, baseHeadingLevel)), { values: {
+            headingLevel: baseHeadingLevel + 1,
+            heading: 'Values',
+            value: enumType.values.map((value) => {
+                var _a;
+                return (Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)((_a = value.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines, linkGenerator)), { value: value.name }));
+            }),
+        } });
 }
-exports.enumTypeToEnumSource = enumTypeToEnumSource;
-function interfaceTypeToInterfaceSource(interfaceType) {
-    return Object.assign(Object.assign({ __type: 'interface' }, baseTypeAdapter(interfaceType)), { extends: interfaceType.extended_interfaces.map(references_1.linkFromTypeNameGenerator), methods: interfaceType.methods.map(methods_and_constructors_1.adaptMethod) });
+function interfaceTypeToInterfaceSource(interfaceType, linkGenerator, baseHeadingLevel = 1) {
+    return Object.assign(Object.assign({ type: 'interface' }, baseTypeAdapter(interfaceType, linkGenerator, baseHeadingLevel)), { extends: interfaceType.extended_interfaces.map(references_1.linkFromTypeNameGenerator), methods: {
+            headingLevel: baseHeadingLevel + 1,
+            heading: 'Methods',
+            value: interfaceType.methods.map((method) => (0, methods_and_constructors_1.adaptMethod)(method, linkGenerator, baseHeadingLevel + 2)),
+        } });
 }
-exports.interfaceTypeToInterfaceSource = interfaceTypeToInterfaceSource;
-function classTypeToClassSource(classType) {
-    return Object.assign(Object.assign({ __type: 'class' }, baseTypeAdapter(classType)), { classModifier: classType.classModifier, sharingModifier: classType.sharingModifier, implements: classType.implemented_interfaces.map(references_1.linkFromTypeNameGenerator), extends: classType.extended_class ? (0, references_1.linkFromTypeNameGenerator)(classType.extended_class) : undefined, methods: classType.methods.map(methods_and_constructors_1.adaptMethod), constructors: classType.constructors.map((constructor) => (0, methods_and_constructors_1.adaptConstructor)(classType.name, constructor)), fields: classType.fields.map((field) => (0, fields_and_properties_1.adaptField)(field)) });
+function classTypeToClassSource(classType, linkGenerator, baseHeadingLevel = 1) {
+    return Object.assign(Object.assign({ type: 'class' }, baseTypeAdapter(classType, linkGenerator, baseHeadingLevel)), { classModifier: classType.classModifier, sharingModifier: classType.sharingModifier, implements: classType.implemented_interfaces.map(references_1.linkFromTypeNameGenerator), extends: classType.extended_class ? (0, references_1.linkFromTypeNameGenerator)(classType.extended_class) : undefined, methods: adaptMembers('Methods', classType.methods, methods_and_constructors_1.adaptMethod, references_1.linkFromTypeNameGenerator, baseHeadingLevel + 1), constructors: adaptMembers('Constructors', classType.constructors, (constructor, linkGenerator, baseHeadingLevel) => (0, methods_and_constructors_1.adaptConstructor)(classType.name, constructor, linkGenerator, baseHeadingLevel), references_1.linkFromTypeNameGenerator, baseHeadingLevel + 1), fields: adaptMembers('Fields', classType.fields, fields_and_properties_1.adaptFieldOrProperty, references_1.linkFromTypeNameGenerator, baseHeadingLevel + 1), properties: adaptMembers('Properties', classType.properties, fields_and_properties_1.adaptFieldOrProperty, references_1.linkFromTypeNameGenerator, baseHeadingLevel + 1), innerClasses: {
+            headingLevel: baseHeadingLevel + 1,
+            heading: 'Classes',
+            value: classType.classes.map((innerClass) => classTypeToClassSource(innerClass, linkGenerator, baseHeadingLevel + 2)),
+        }, innerEnums: {
+            headingLevel: baseHeadingLevel + 1,
+            heading: 'Enums',
+            value: classType.enums.map((innerEnum) => enumTypeToEnumSource(innerEnum, linkGenerator, baseHeadingLevel + 2)),
+        }, innerInterfaces: {
+            headingLevel: baseHeadingLevel + 1,
+            heading: 'Interfaces',
+            value: classType.interfaces.map((innerInterface) => interfaceTypeToInterfaceSource(innerInterface, linkGenerator, baseHeadingLevel + 2)),
+        } });
+}
+function adaptMembers(heading, members, adapter, linkFromTypeNameGenerator, headingLevel) {
+    return {
+        headingLevel,
+        heading,
+        isGrouped: hasGroup(members),
+        value: hasGroup(members)
+            ? toGroupedMembers(members, adapter, linkFromTypeNameGenerator, headingLevel + 1)
+            : toFlat(members, adapter, linkFromTypeNameGenerator, headingLevel + 1),
+    };
+}
+function hasGroup(members) {
+    return members.some((member) => member.group);
+}
+function toFlat(members, adapter, linkGenerator, baseHeadingLevel) {
+    return members.map((member) => adapter(member, linkGenerator, baseHeadingLevel));
+}
+function toGroupedMembers(members, adapter, linkGenerator, baseHeadingLevel) {
+    const groupedMembers = groupByGroupName(members);
+    return Object.entries(groupedMembers).map(([groupName, members]) => singleGroup(baseHeadingLevel, groupName, adapter, members, linkGenerator));
+}
+function groupByGroupName(members) {
+    return members.reduce((acc, member) => {
+        var _a, _b;
+        const groupName = (_a = member.group) !== null && _a !== void 0 ? _a : 'Other';
+        acc[groupName] = (_b = acc[groupName]) !== null && _b !== void 0 ? _b : [];
+        acc[groupName].push(member);
+        return acc;
+    }, {});
+}
+function singleGroup(headingLevel, groupName, adapter, members, linkGenerator) {
+    return {
+        headingLevel: headingLevel,
+        heading: groupName,
+        groupDescription: members[0].groupDescription, // All fields in the group have the same description
+        value: toFlat(members, adapter, linkGenerator, headingLevel + 1),
+    };
 }
-exports.classTypeToClassSource = classTypeToClassSource;
 //# sourceMappingURL=apex-types.js.map

package/lib/adapters/apex-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"apex-types.js","sourceRoot":"","sources":["../../src/adapters/apex-types.ts"],"names":[],"mappings":";;;AAEA,mDAAsE;AACtE,6CAAyD;AAEzD,yEAA2E;AAC3E,mEAAqD;AAErD,SAAS,eAAe,CAAC,IAAgD;IACvE,SAAS,qBAAqB,CAAC,IAAU,EAAE,cAAsB;;QAC/D,OAAO,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CACtC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAC/E,0CAAE,IAAI,CAAC;IACV,CAAC;IAED,SAAS,qBAAqB,CAAC,IAAU;;QACvC,OAAO,CACL,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CACzB,MAAM,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,EAC5E,GAAG,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,mCAAI,EAAE,CAC5D,CAAC;IACJ,CAAC;IAED,uCACK,IAAA,iCAAiB,EAAC,IAAI,CAAC,KAC1B,cAAc,EAAE,IAAI,CAAC,eAAe,EACpC,IAAI,EAAE,IAAI,CAAC,IAAI,EACf,KAAK,EAAE,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,EAC3C,MAAM,EAAE,qBAAqB,CAAC,IAAI,EAAE,QAAQ,CAAC,EAC7C,IAAI,EAAE,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC,EACzC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,sCAAyB,CAAC,IAChE;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAAC,QAAoB;IACvD,qCACE,MAAM,EAAE,MAAM,IACX,eAAe,CAAC,QAAQ,CAAC,KAC5B,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;YAAC,OAAA,iCAClC,IAAA,gCAAgB,EAAC,MAAA,KAAK,CAAC,UAAU,0CAAE,gBAAgB,CAAC,KACvD,KAAK,EAAE,KAAK,CAAC,IAAI,IACjB,CAAA;SAAA,CAAC,IACH;AACJ,CAAC;AATD,oDASC;AAED,SAAgB,8BAA8B,CAAC,aAA8B;IAC3E,qCACE,MAAM,EAAE,WAAW,IAChB,eAAe,CAAC,aAAa,CAAC,KACjC,OAAO,EAAE,aAAa,CAAC,mBAAmB,CAAC,GAAG,CAAC,sCAAyB,CAAC,EACzE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,sCAAW,CAAC,IAC/C;AACJ,CAAC;AAPD,wEAOC;AAED,SAAgB,sBAAsB,CAAC,SAAsB;IAC3D,qCACE,MAAM,EAAE,OAAO,IACZ,eAAe,CAAC,SAAS,CAAC,KAC7B,aAAa,EAAE,SAAS,CAAC,aAAa,EACtC,eAAe,EAAE,SAAS,CAAC,eAAe,EAC1C,UAAU,EAAE,SAAS,CAAC,sBAAsB,CAAC,GAAG,CAAC,sCAAyB,CAAC,EAC3E,OAAO,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,IAAA,sCAAyB,EAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,EACnG,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,sCAAW,CAAC,EAC3C,YAAY,EAAE,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAA,2CAAgB,EAAC,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,EACxG,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,kCAAU,EAAC,KAAmC,CAAC,CAAC,IACxF;AACJ,CAAC;AAZD,wDAYC"}
+{"version":3,"file":"apex-types.js","sourceRoot":"","sources":["../../src/adapters/apex-types.ts"],"names":[],"mappings":";;AA0CA,oDAoBC;AAED,oDAiBC;AAED,wEAeC;AAED,wDAuDC;AAjJD,mDAAsE;AACtE,6CAAyF;AAEzF,yEAA2E;AAC3E,mEAA+D;AAE/D,SAAS,eAAe,CACtB,IAAgD,EAChD,aAA6C,EAC7C,gBAAwB;IAExB,SAAS,UAAU,CAAC,IAAU;QAC5B,MAAM,SAAS,GAAG;YAChB,KAAK,EAAE,OAAO;YACd,SAAS,EAAE,WAAW;YACtB,IAAI,EAAE,MAAM;SACb,CAAC;QAEF,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;IACrD,CAAC;IAED,OAAO;QACL,YAAY,EAAE,gBAAgB;QAC9B,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC;QACzB,GAAG,EAAE,IAAA,iCAAiB,EAAC,IAAI,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QACjE,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE;YACJ,cAAc,EAAE,IAAI,CAAC,eAAe;SACrC;KACF,CAAC;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAClC,IAAU,EACV,aAA6C,EAC7C,SAAkB;IAElB,SAAS,aAAa;QACpB,QAAQ,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,KAAK,MAAM;gBACT,OAAO,oBAAoB,CAAC,IAAkB,EAAE,aAAa,CAAC,CAAC;YACjE,KAAK,WAAW;gBACd,OAAO,8BAA8B,CAAC,IAAuB,EAAE,aAAa,CAAC,CAAC;YAChF,KAAK,OAAO;gBACV,OAAO,sBAAsB,CAAC,IAAmB,EAAE,aAAa,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAED,uCACK,aAAa,EAAE,KAClB,SAAS,IACT;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAClC,QAAoB,EACpB,aAA6C,EAC7C,mBAA2B,CAAC;IAE5B,qCACE,IAAI,EAAE,MAAM,IACT,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,gBAAgB,CAAC,KAC7D,MAAM,EAAE;YACN,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;gBAAC,OAAA,iCACjC,IAAA,gCAAgB,EAAC,MAAA,KAAK,CAAC,UAAU,0CAAE,gBAAgB,EAAE,aAAa,CAAC,KACtE,KAAK,EAAE,KAAK,CAAC,IAAI,IACjB,CAAA;aAAA,CAAC;SACJ,IACD;AACJ,CAAC;AAED,SAAgB,8BAA8B,CAC5C,aAA8B,EAC9B,aAA6C,EAC7C,mBAA2B,CAAC;IAE5B,qCACE,IAAI,EAAE,WAAW,IACd,eAAe,CAAC,aAAa,EAAE,aAAa,EAAE,gBAAgB,CAAC,KAClE,OAAO,EAAE,aAAa,CAAC,mBAAmB,CAAC,GAAG,CAAC,sCAAyB,CAAC,EACzE,OAAO,EAAE;YACP,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAA,sCAAW,EAAC,MAAM,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CAAC;SACvG,IACD;AACJ,CAAC;AAED,SAAgB,sBAAsB,CACpC,SAAsB,EACtB,aAA6C,EAC7C,mBAA2B,CAAC;IAE5B,qCACE,IAAI,EAAE,OAAO,IACV,eAAe,CAAC,SAAS,EAAE,aAAa,EAAE,gBAAgB,CAAC,KAC9D,aAAa,EAAE,SAAS,CAAC,aAAa,EACtC,eAAe,EAAE,SAAS,CAAC,eAAe,EAC1C,UAAU,EAAE,SAAS,CAAC,sBAAsB,CAAC,GAAG,CAAC,sCAAyB,CAAC,EAC3E,OAAO,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,IAAA,sCAAyB,EAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,EACnG,OAAO,EAAE,YAAY,CAAC,SAAS,EAAE,SAAS,CAAC,OAAO,EAAE,sCAAW,EAAE,sCAAyB,EAAE,gBAAgB,GAAG,CAAC,CAAC,EACjH,YAAY,EAAE,YAAY,CACxB,cAAc,EACd,SAAS,CAAC,YAAY,EACtB,CAAC,WAAW,EAAE,aAAa,EAAE,gBAAgB,EAAE,EAAE,CAC/C,IAAA,2CAAgB,EAAC,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE,gBAAgB,CAAC,EAChF,sCAAyB,EACzB,gBAAgB,GAAG,CAAC,CACrB,EACD,MAAM,EAAE,YAAY,CAClB,QAAQ,EACR,SAAS,CAAC,MAAsC,EAChD,4CAAoB,EACpB,sCAAyB,EACzB,gBAAgB,GAAG,CAAC,CACrB,EACD,UAAU,EAAE,YAAY,CACtB,YAAY,EACZ,SAAS,CAAC,UAA6C,EACvD,4CAAoB,EACpB,sCAAyB,EACzB,gBAAgB,GAAG,CAAC,CACrB,EACD,YAAY,EAAE;YACZ,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAC1C,sBAAsB,CAAC,UAAU,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CACxE;SACF,EACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,oBAAoB,CAAC,SAAS,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CAAC;SAChH,EACD,eAAe,EAAE;YACf,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CACjD,8BAA8B,CAAC,cAAc,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CACpF;SACF,IACD;AACJ,CAAC;AAID,SAAS,YAAY,CACnB,OAAe,EACf,OAAY,EACZ,OAAkG,EAClG,yBAAyD,EACzD,YAAoB;IAEpB,OAAO;QACL,YAAY;QACZ,OAAO;QACP,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC;QAC5B,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC;YACtB,CAAC,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,YAAY,GAAG,CAAC,CAAC;YACjF,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,YAAY,GAAG,CAAC,CAAC;KAC1E,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,OAAoB;IACpC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,MAAM,CACb,OAAY,EACZ,OAAkG,EAClG,aAA6C,EAC7C,gBAAwB;IAExB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,gBAAgB,CAAC,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,gBAAgB,CACvB,OAAY,EACZ,OAAkG,EAClG,aAA6C,EAC7C,gBAAwB;IAExB,MAAM,cAAc,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACjD,OAAO,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,EAAE,CACjE,WAAW,CAAC,gBAAgB,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,CAAC,CAC1E,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAsB,OAAY;IACzD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;;QACpC,MAAM,SAAS,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,OAAO,CAAC;QAC1C,GAAG,CAAC,SAAS,CAAC,GAAG,MAAA,GAAG,CAAC,SAAS,CAAC,mCAAI,EAAE,CAAC;QACtC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAyB,CAAC,CAAC;AAChC,CAAC;AAED,SAAS,WAAW,CAClB,YAAoB,EACpB,SAAiB,EACjB,OAAkG,EAClG,OAAY,EACZ,aAA6C;IAE7C,OAAO;QACL,YAAY,EAAE,YAAY;QAC1B,OAAO,EAAE,SAAS;QAClB,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,gBAAgB,EAAE,oDAAoD;QACnG,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,YAAY,GAAG,CAAC,CAAC;KACjE,CAAC;AACJ,CAAC"}

package/lib/adapters/documentables.d.ts

@@ -1,6 +1,7 @@
-import { DocumentableSource, RenderableContent } from '../templating/types';
+import { RenderableDocumentation, RenderableContent } from '../core/renderable/types';
 import { Describable, Documentable } from './types';
-export declare function adaptDescribable(describable: Describable): {
+import { GetRenderableContentByTypeName } from './references';
+export declare function adaptDescribable(describable: Describable, linkGenerator: GetRenderableContentByTypeName): {
     description?: RenderableContent[];
 };
-export declare function adaptDocumentable(documentable: Documentable): DocumentableSource;
+export declare function adaptDocumentable(documentable: Documentable, linkGenerator: GetRenderableContentByTypeName, subHeadingLevel: number): RenderableDocumentation;

package/lib/adapters/documentables.js

@@ -1,16 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.adaptDocumentable = exports.adaptDescribable = void 0;
+exports.adaptDescribable = adaptDescribable;
+exports.adaptDocumentable = adaptDocumentable;
 const references_1 = require("./references");
 const type_utils_1 = require("./type-utils");
-function adaptDescribable(describable) {
+function adaptDescribable(describable, linkGenerator) {
     function describableToRenderableContent(describable) {
         if (!describable) {
             return;
         }
         return (describable
             .map((line) => [
-            ...(0, references_1.replaceInlineReferences)(line),
+            ...(0, references_1.replaceInlineReferences)(line, linkGenerator),
             {
                 type: 'empty-line',
             },
@@ -23,19 +24,33 @@ function adaptDescribable(describable) {
         description: describableToRenderableContent(describable),
     };
 }
-exports.adaptDescribable = adaptDescribable;
-function adaptDocumentable(documentable) {
+function adaptDocumentable(documentable, linkGenerator, subHeadingLevel) {
     var _a, _b, _c;
     function extractCustomTags(type) {
         var _a, _b;
         const baseTags = ['description', 'group', 'author', 'date', 'see', 'example', 'mermaid', 'throws', 'exception'];
-        return ((_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((currentAnnotation) => !baseTags.includes(currentAnnotation.name.toLowerCase())).map((currentAnnotation) => (Object.assign(Object.assign({}, adaptDescribable(currentAnnotation.bodyLines)), { name: currentAnnotation.name })))) !== null && _b !== void 0 ? _b : []);
+        return ((_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((currentAnnotation) => !baseTags.includes(currentAnnotation.name.toLowerCase())).map((currentAnnotation) => (Object.assign(Object.assign({}, adaptDescribable(currentAnnotation.bodyLines, linkGenerator)), { name: currentAnnotation.name })))) !== null && _b !== void 0 ? _b : []);
     }
     function extractAnnotationBodyLines(type, annotationName) {
         var _a, _b;
         return (_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((currentAnnotation) => currentAnnotation.name.toLowerCase() === annotationName)) === null || _b === void 0 ? void 0 : _b.bodyLines;
     }
-    return Object.assign(Object.assign({}, adaptDescribable((_a = documentable.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines)), { annotations: documentable.annotations.map((annotation) => annotation.type.toUpperCase()), customTags: extractCustomTags(documentable), mermaid: extractAnnotationBodyLines(documentable, 'mermaid'), example: (_c = (_b = documentable.docComment) === null || _b === void 0 ? void 0 : _b.exampleAnnotation) === null || _c === void 0 ? void 0 : _c.bodyLines });
+    function extractAnnotationBody(type, annotationName) {
+        var _a, _b;
+        return (_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((currentAnnotation) => currentAnnotation.name.toLowerCase() === annotationName)) === null || _b === void 0 ? void 0 : _b.body;
+    }
+    function extractSeeAnnotations(type) {
+        var _a, _b;
+        return ((_b = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((currentAnnotation) => currentAnnotation.name.toLowerCase() === 'see').map((currentAnnotation) => currentAnnotation.body)) !== null && _b !== void 0 ? _b : []);
+    }
+    return Object.assign(Object.assign({}, adaptDescribable((_a = documentable.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines, linkGenerator)), { annotations: documentable.annotations.map((annotation) => annotation.type.toUpperCase()), customTags: extractCustomTags(documentable), mermaid: {
+            headingLevel: subHeadingLevel,
+            heading: 'Diagram',
+            value: extractAnnotationBodyLines(documentable, 'mermaid'),
+        }, example: {
+            headingLevel: subHeadingLevel,
+            heading: 'Example',
+            value: (_c = (_b = documentable.docComment) === null || _b === void 0 ? void 0 : _b.exampleAnnotation) === null || _c === void 0 ? void 0 : _c.bodyLines,
+        }, group: extractAnnotationBody(documentable, 'group'), author: extractAnnotationBody(documentable, 'author'), date: extractAnnotationBody(documentable, 'date'), sees: extractSeeAnnotations(documentable).map(linkGenerator) });
 }
-exports.adaptDocumentable = adaptDocumentable;
 //# sourceMappingURL=documentables.js.map

package/lib/adapters/documentables.js.map

@@ -1 +1 @@
-{"version":3,"file":"documentables.js","sourceRoot":"","sources":["../../src/adapters/documentables.ts"],"names":[],"mappings":";;;AAEA,6CAAuD;AACvD,6CAA2C;AAE3C,SAAgB,gBAAgB,CAAC,WAAwB;IACvD,SAAS,8BAA8B,CAAC,WAAwB;QAC9D,IAAI,CAAC,WAAW,EAAE;YAChB,OAAO;SACR;QAED,OAAO,CACL,WAAW;aACR,GAAG,CAAsB,CAAC,IAAI,EAAE,EAAE,CAAC;YAClC,GAAG,IAAA,oCAAuB,EAAC,IAAI,CAAC;YAChC;gBACE,IAAI,EAAE,YAAY;aACnB;SACF,CAAC;aACD,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC;YACxB,kDAAkD;aACjD,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAA,wBAAW,EAAC,IAAI,CAAC,IAAI,KAAK,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CACtF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,WAAW,EAAE,8BAA8B,CAAC,WAAW,CAAC;KACzD,CAAC;AACJ,CAAC;AAvBD,4CAuBC;AAED,SAAgB,iBAAiB,CAAC,YAA0B;;IAC1D,SAAS,iBAAiB,CAAC,IAAkB;;QAC3C,MAAM,QAAQ,GAAG,CAAC,aAAa,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAEhH,OAAO,CACL,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CACzB,MAAM,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EACtF,GAAG,CAAY,CAAC,iBAAiB,EAAE,EAAE,CAAC,iCAClC,gBAAgB,CAAC,iBAAiB,CAAC,SAAS,CAAC,KAChD,IAAI,EAAE,iBAAiB,CAAC,IAAI,IAC5B,CAAC,mCAAI,EAAE,CACZ,CAAC;IACJ,CAAC;IAED,SAAS,0BAA0B,CAAC,IAAkB,EAAE,cAAsB;;QAC5E,OAAO,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CACtC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAC/E,0CAAE,SAAS,CAAC;IACf,CAAC;IAED,uCACK,gBAAgB,CAAC,MAAA,YAAY,CAAC,UAAU,0CAAE,gBAAgB,CAAC,KAC9D,WAAW,EAAE,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EACxF,UAAU,EAAE,iBAAiB,CAAC,YAAY,CAAC,EAC3C,OAAO,EAAE,0BAA0B,CAAC,YAAY,EAAE,SAAS,CAAC,EAC5D,OAAO,EAAE,MAAA,MAAA,YAAY,CAAC,UAAU,0CAAE,iBAAiB,0CAAE,SAAS,IAC9D;AACJ,CAAC;AA3BD,8CA2BC"}
+{"version":3,"file":"documentables.js","sourceRoot":"","sources":["../../src/adapters/documentables.ts"],"names":[],"mappings":";;AAKA,4CA4BC;AAED,8CAyDC;AA1FD,6CAAuF;AACvF,6CAA2C;AAE3C,SAAgB,gBAAgB,CAC9B,WAAwB,EACxB,aAA6C;IAI7C,SAAS,8BAA8B,CAAC,WAAwB;QAC9D,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO;QACT,CAAC;QAED,OAAO,CACL,WAAW;aACR,GAAG,CAAsB,CAAC,IAAI,EAAE,EAAE,CAAC;YAClC,GAAG,IAAA,oCAAuB,EAAC,IAAI,EAAE,aAAa,CAAC;YAC/C;gBACE,IAAI,EAAE,YAAY;aACnB;SACF,CAAC;aACD,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC;YACxB,kDAAkD;aACjD,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAA,wBAAW,EAAC,IAAI,CAAC,IAAI,KAAK,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CACtF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,WAAW,EAAE,8BAA8B,CAAC,WAAW,CAAC;KACzD,CAAC;AACJ,CAAC;AAED,SAAgB,iBAAiB,CAC/B,YAA0B,EAC1B,aAA6C,EAC7C,eAAuB;;IAEvB,SAAS,iBAAiB,CAAC,IAAkB;;QAC3C,MAAM,QAAQ,GAAG,CAAC,aAAa,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAEhH,OAAO,CACL,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CACzB,MAAM,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EACtF,GAAG,CAAY,CAAC,iBAAiB,EAAE,EAAE,CAAC,iCAClC,gBAAgB,CAAC,iBAAiB,CAAC,SAAS,EAAE,aAAa,CAAC,KAC/D,IAAI,EAAE,iBAAiB,CAAC,IAAI,IAC5B,CAAC,mCAAI,EAAE,CACZ,CAAC;IACJ,CAAC;IAED,SAAS,0BAA0B,CAAC,IAAkB,EAAE,cAAsB;;QAC5E,OAAO,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CACtC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAC/E,0CAAE,SAAS,CAAC;IACf,CAAC;IAED,SAAS,qBAAqB,CAAC,IAAkB,EAAE,cAAsB;;QACvE,OAAO,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CACtC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAC/E,0CAAE,IAAI,CAAC;IACV,CAAC;IAED,SAAS,qBAAqB,CAAC,IAAkB;;QAC/C,OAAO,CACL,MAAA,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CACzB,MAAM,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,EAC5E,GAAG,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,mCAAI,EAAE,CAC5D,CAAC;IACJ,CAAC;IAED,uCACK,gBAAgB,CAAC,MAAA,YAAY,CAAC,UAAU,0CAAE,gBAAgB,EAAE,aAAa,CAAC,KAC7E,WAAW,EAAE,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EACxF,UAAU,EAAE,iBAAiB,CAAC,YAAY,CAAC,EAC3C,OAAO,EAAE;YACP,YAAY,EAAE,eAAe;YAC7B,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,0BAA0B,CAAC,YAAY,EAAE,SAAS,CAAC;SAC3D,EACD,OAAO,EAAE;YACP,YAAY,EAAE,eAAe;YAC7B,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,MAAA,MAAA,YAAY,CAAC,UAAU,0CAAE,iBAAiB,0CAAE,SAAS;SAC7D,EACD,KAAK,EAAE,qBAAqB,CAAC,YAAY,EAAE,OAAO,CAAC,EACnD,MAAM,EAAE,qBAAqB,CAAC,YAAY,EAAE,QAAQ,CAAC,EACrD,IAAI,EAAE,qBAAqB,CAAC,YAAY,EAAE,MAAM,CAAC,EACjD,IAAI,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,IAC5D;AACJ,CAAC"}

package/lib/adapters/fields-and-properties.d.ts

@@ -1,3 +1,4 @@
-import { FieldMirrorWithInheritance } from '../model/inheritance';
-import { FieldSource } from '../templating/types';
-export declare function adaptField(field: FieldMirrorWithInheritance): FieldSource;
+import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance } from '../model/inheritance';
+import { RenderableField } from '../core/renderable/types';
+import { GetRenderableContentByTypeName } from './references';
+export declare function adaptFieldOrProperty(field: FieldMirrorWithInheritance | PropertyMirrorWithInheritance, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel: number): RenderableField;

package/lib/adapters/fields-and-properties.js

@@ -1,10 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.adaptField = void 0;
+exports.adaptFieldOrProperty = adaptFieldOrProperty;
 const documentables_1 = require("./documentables");
 const references_1 = require("./references");
-function adaptField(field) {
-    return Object.assign(Object.assign({}, (0, documentables_1.adaptDocumentable)(field)), { name: field.name, type: (0, references_1.linkFromTypeNameGenerator)(field.typeReference.rawDeclaration), inherited: field.inherited, accessModifier: field.access_modifier });
+function adaptFieldOrProperty(field, linkGenerator, baseHeadingLevel) {
+    function buildSignature() {
+        const { access_modifier, name } = field;
+        const memberModifiers = field.memberModifiers.join(' ');
+        return (`${access_modifier} ${memberModifiers} ${name}`
+            // remove double spaces
+            .replace(/ {2}/g, ' '));
+    }
+    return {
+        headingLevel: baseHeadingLevel,
+        doc: (0, documentables_1.adaptDocumentable)(field, linkGenerator, baseHeadingLevel + 1),
+        heading: field.name,
+        type: {
+            headingLevel: baseHeadingLevel + 1,
+            heading: 'Type',
+            value: (0, references_1.linkFromTypeNameGenerator)(field.typeReference.rawDeclaration),
+        },
+        inherited: field.inherited,
+        accessModifier: field.access_modifier,
+        signature: {
+            headingLevel: baseHeadingLevel + 1,
+            heading: 'Signature',
+            value: [buildSignature()],
+        },
+    };
 }
-exports.adaptField = adaptField;
 //# sourceMappingURL=fields-and-properties.js.map

package/lib/adapters/fields-and-properties.js.map

@@ -1 +1 @@
-{"version":3,"file":"fields-and-properties.js","sourceRoot":"","sources":["../../src/adapters/fields-and-properties.ts"],"names":[],"mappings":";;;AAEA,mDAAoD;AACpD,6CAAyD;AAEzD,SAAgB,UAAU,CAAC,KAAiC;IAC1D,uCACK,IAAA,iCAAiB,EAAC,KAAK,CAAC,KAC3B,IAAI,EAAE,KAAK,CAAC,IAAI,EAChB,IAAI,EAAE,IAAA,sCAAyB,EAAC,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,EACnE,SAAS,EAAE,KAAK,CAAC,SAAS,EAC1B,cAAc,EAAE,KAAK,CAAC,eAAe,IACrC;AACJ,CAAC;AARD,gCAQC"}
+{"version":3,"file":"fields-and-properties.js","sourceRoot":"","sources":["../../src/adapters/fields-and-properties.ts"],"names":[],"mappings":";;AAKA,oDAgCC;AAnCD,mDAAoD;AACpD,6CAAyF;AAEzF,SAAgB,oBAAoB,CAClC,KAAiE,EACjE,aAA6C,EAC7C,gBAAwB;IAExB,SAAS,cAAc;QACrB,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QACxC,MAAM,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxD,OAAO,CACL,GAAG,eAAe,IAAI,eAAe,IAAI,IAAI,EAAE;YAC7C,uBAAuB;aACtB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CACzB,CAAC;IACJ,CAAC;IAED,OAAO;QACL,YAAY,EAAE,gBAAgB;QAC9B,GAAG,EAAE,IAAA,iCAAiB,EAAC,KAAK,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QAClE,OAAO,EAAE,KAAK,CAAC,IAAI;QACnB,IAAI,EAAE;YACJ,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,IAAA,sCAAyB,EAAC,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC;SACrE;QACD,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,cAAc,EAAE,KAAK,CAAC,eAAe;QACrC,SAAS,EAAE;YACT,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,CAAC,cAAc,EAAE,CAAC;SAC1B;KACF,CAAC;AACJ,CAAC"}

package/lib/adapters/methods-and-constructors.d.ts

@@ -1,4 +1,5 @@
 import { ConstructorMirror, MethodMirror } from '@cparra/apex-reflection';
-import { ConstructorSource, MethodSource } from '../templating/types';
-export declare function adaptMethod(method: MethodMirror): MethodSource;
-export declare function adaptConstructor(typeName: string, constructor: ConstructorMirror): ConstructorSource;
+import { RenderableConstructor, RenderableMethod } from '../core/renderable/types';
+import { GetRenderableContentByTypeName } from './references';
+export declare function adaptMethod(method: MethodMirror, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel: number): RenderableMethod;
+export declare function adaptConstructor(typeName: string, constructor: ConstructorMirror, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel: number): RenderableConstructor;

package/lib/adapters/methods-and-constructors.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.adaptConstructor = exports.adaptMethod = void 0;
+exports.adaptMethod = adaptMethod;
+exports.adaptConstructor = adaptConstructor;
 const documentables_1 = require("./documentables");
 const references_1 = require("./references");
-function adaptMethod(method) {
+function adaptMethod(method, linkGenerator, baseHeadingLevel) {
     var _a, _b, _c;
     function buildTitle(method) {
         const { name, parameters } = method;
@@ -18,10 +19,34 @@ function adaptMethod(method) {
         const members = memberModifiers.length > 0 ? `${memberModifiers.join(' ')} ` : '';
         return `${access_modifier} ${members}${typeReference.rawDeclaration} ${name}(${parameters})`;
     }
-    return Object.assign(Object.assign({}, (0, documentables_1.adaptDocumentable)(method)), { title: buildTitle(method), signature: buildSignature(method), returnType: Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)((_b = (_a = method.docComment) === null || _a === void 0 ? void 0 : _a.returnAnnotation) === null || _b === void 0 ? void 0 : _b.bodyLines)), { type: (0, references_1.linkFromTypeNameGenerator)(method.typeReference.rawDeclaration) }), throws: (_c = method.docComment) === null || _c === void 0 ? void 0 : _c.throwsAnnotations.map((thrown) => mapThrows(thrown)), parameters: method.parameters.map((param) => mapParameters(method, param)), inherited: method.inherited });
+    return {
+        headingLevel: baseHeadingLevel,
+        doc: (0, documentables_1.adaptDocumentable)(method, linkGenerator, baseHeadingLevel + 1),
+        heading: buildTitle(method),
+        signature: {
+            headingLevel: baseHeadingLevel + 1,
+            heading: 'Signature',
+            value: [buildSignature(method)],
+        },
+        returnType: {
+            headingLevel: baseHeadingLevel + 1,
+            heading: 'Return Type',
+            value: Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)((_b = (_a = method.docComment) === null || _a === void 0 ? void 0 : _a.returnAnnotation) === null || _b === void 0 ? void 0 : _b.bodyLines, linkGenerator)), { type: (0, references_1.linkFromTypeNameGenerator)(method.typeReference.rawDeclaration) }),
+        },
+        throws: {
+            headingLevel: baseHeadingLevel + 1,
+            heading: 'Throws',
+            value: (_c = method.docComment) === null || _c === void 0 ? void 0 : _c.throwsAnnotations.map((thrown) => mapThrows(thrown)),
+        },
+        parameters: {
+            headingLevel: baseHeadingLevel + 1,
+            heading: 'Parameters',
+            value: method.parameters.map((param) => mapParameters(method, param)),
+        },
+        inherited: method.inherited,
+    };
 }
-exports.adaptMethod = adaptMethod;
-function adaptConstructor(typeName, constructor) {
+function adaptConstructor(typeName, constructor, linkGenerator, baseHeadingLevel) {
     var _a;
     function buildTitle(name, constructor) {
         const { parameters } = constructor;
@@ -35,15 +60,33 @@ function adaptConstructor(typeName, constructor) {
             .join(', ');
         return `${access_modifier} ${name}(${parameters})`;
     }
-    return Object.assign(Object.assign({}, (0, documentables_1.adaptDocumentable)(constructor)), { title: buildTitle(typeName, constructor), signature: buildSignature(typeName, constructor), parameters: constructor.parameters.map((param) => mapParameters(constructor, param)), throws: (_a = constructor.docComment) === null || _a === void 0 ? void 0 : _a.throwsAnnotations.map((thrown) => mapThrows(thrown)) });
+    return {
+        doc: (0, documentables_1.adaptDocumentable)(constructor, linkGenerator, baseHeadingLevel + 1),
+        headingLevel: baseHeadingLevel,
+        heading: buildTitle(typeName, constructor),
+        signature: {
+            headingLevel: baseHeadingLevel + 1,
+            heading: 'Signature',
+            value: [buildSignature(typeName, constructor)],
+        },
+        parameters: {
+            headingLevel: baseHeadingLevel + 1,
+            heading: 'Parameters',
+            value: constructor.parameters.map((param) => mapParameters(constructor, param)),
+        },
+        throws: {
+            headingLevel: baseHeadingLevel + 1,
+            heading: 'Throws',
+            value: (_a = constructor.docComment) === null || _a === void 0 ? void 0 : _a.throwsAnnotations.map((thrown) => mapThrows(thrown)),
+        },
+    };
 }
-exports.adaptConstructor = adaptConstructor;
 function mapParameters(documentable, param) {
     var _a;
     const paramAnnotation = (_a = documentable.docComment) === null || _a === void 0 ? void 0 : _a.paramAnnotations.find((pa) => pa.paramName.toLowerCase() === param.name.toLowerCase());
-    return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(paramAnnotation === null || paramAnnotation === void 0 ? void 0 : paramAnnotation.bodyLines)), { name: param.name, type: (0, references_1.linkFromTypeNameGenerator)(param.typeReference.rawDeclaration) });
+    return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(paramAnnotation === null || paramAnnotation === void 0 ? void 0 : paramAnnotation.bodyLines, references_1.linkFromTypeNameGenerator)), { name: param.name, type: (0, references_1.linkFromTypeNameGenerator)(param.typeReference.rawDeclaration) });
 }
 function mapThrows(thrown) {
-    return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(thrown.bodyLines)), { type: (0, references_1.linkFromTypeNameGenerator)(thrown.exceptionName) });
+    return Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)(thrown.bodyLines, references_1.linkFromTypeNameGenerator)), { type: (0, references_1.linkFromTypeNameGenerator)(thrown.exceptionName) });
 }
 //# sourceMappingURL=methods-and-constructors.js.map

package/lib/adapters/methods-and-constructors.js.map

@@ -1 +1 @@
-{"version":3,"file":"methods-and-constructors.js","sourceRoot":"","sources":["../../src/adapters/methods-and-constructors.ts"],"names":[],"mappings":";;;AAGA,mDAAsE;AACtE,6CAAyD;AAGzD,SAAgB,WAAW,CAAC,MAAoB;;IAC9C,SAAS,UAAU,CAAC,MAAmC;QACrD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QACpC,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,OAAO,GAAG,IAAI,IAAI,gBAAgB,GAAG,CAAC;IACxC,CAAC;IAED,SAAS,cAAc,CAAC,MAAmC;QACzD,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACzE,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU;aACjC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACrE,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAClF,OAAO,GAAG,eAAe,IAAI,OAAO,GAAG,aAAa,CAAC,cAAc,IAAI,IAAI,IAAI,UAAU,GAAG,CAAC;IAC/F,CAAC;IAED,uCACK,IAAA,iCAAiB,EAAC,MAAM,CAAC,KAC5B,KAAK,EAAE,UAAU,CAAC,MAAqC,CAAC,EACxD,SAAS,EAAE,cAAc,CAAC,MAAqC,CAAC,EAChE,UAAU,kCACL,IAAA,gCAAgB,EAAC,MAAA,MAAA,MAAM,CAAC,UAAU,0CAAE,gBAAgB,0CAAE,SAAS,CAAC,KACnE,IAAI,EAAE,IAAA,sCAAyB,EAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,KAEtE,MAAM,EAAE,MAAA,MAAM,CAAC,UAAU,0CAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAC/E,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EAC1E,SAAS,EAAG,MAAsC,CAAC,SAAS,IAC5D;AACJ,CAAC;AA5BD,kCA4BC;AAED,SAAgB,gBAAgB,CAAC,QAAgB,EAAE,WAA8B;;IAC/E,SAAS,UAAU,CAAC,IAAY,EAAE,WAA8B;QAC9D,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC;QACnC,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,OAAO,GAAG,IAAI,IAAI,gBAAgB,GAAG,CAAC;IACxC,CAAC;IAED,SAAS,cAAc,CAAC,IAAY,EAAE,WAA8B;QAClE,MAAM,EAAE,eAAe,EAAE,GAAG,WAAW,CAAC;QACxC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU;aACtC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACrE,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,OAAO,GAAG,eAAe,IAAI,IAAI,IAAI,UAAU,GAAG,CAAC;IACrD,CAAC;IAED,uCACK,IAAA,iCAAiB,EAAC,WAAW,CAAC,KACjC,KAAK,EAAE,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAC,EACxC,SAAS,EAAE,cAAc,CAAC,QAAQ,EAAE,WAAW,CAAC,EAChD,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,EACpF,MAAM,EAAE,MAAA,WAAW,CAAC,UAAU,0CAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IACpF;AACJ,CAAC;AAtBD,4CAsBC;AAED,SAAS,aAAa,CAAC,YAA0B,EAAE,KAAsB;;IACvE,MAAM,eAAe,GAAG,MAAA,YAAY,CAAC,UAAU,0CAAE,gBAAgB,CAAC,IAAI,CACpE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAChE,CAAC;IACF,uCACK,IAAA,gCAAgB,EAAC,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,SAAS,CAAC,KAC/C,IAAI,EAAE,KAAK,CAAC,IAAI,EAChB,IAAI,EAAE,IAAA,sCAAyB,EAAC,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,IACnE;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,MAAwB;IACzC,uCACK,IAAA,gCAAgB,EAAC,MAAM,CAAC,SAAS,CAAC,KACrC,IAAI,EAAE,IAAA,sCAAyB,EAAC,MAAM,CAAC,aAAa,CAAC,IACrD;AACJ,CAAC"}
+{"version":3,"file":"methods-and-constructors.js","sourceRoot":"","sources":["../../src/adapters/methods-and-constructors.ts"],"names":[],"mappings":";;AAOA,kCAiDC;AAED,4CAwCC;AA/FD,mDAAsE;AACtE,6CAAyF;AAGzF,SAAgB,WAAW,CACzB,MAAoB,EACpB,aAA6C,EAC7C,gBAAwB;;IAExB,SAAS,UAAU,CAAC,MAAmC;QACrD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QACpC,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,OAAO,GAAG,IAAI,IAAI,gBAAgB,GAAG,CAAC;IACxC,CAAC;IAED,SAAS,cAAc,CAAC,MAAmC;QACzD,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACzE,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU;aACjC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACrE,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAClF,OAAO,GAAG,eAAe,IAAI,OAAO,GAAG,aAAa,CAAC,cAAc,IAAI,IAAI,IAAI,UAAU,GAAG,CAAC;IAC/F,CAAC;IAED,OAAO;QACL,YAAY,EAAE,gBAAgB;QAC9B,GAAG,EAAE,IAAA,iCAAiB,EAAC,MAAM,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QACnE,OAAO,EAAE,UAAU,CAAC,MAAqC,CAAC;QAC1D,SAAS,EAAE;YACT,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,CAAC,cAAc,CAAC,MAAqC,CAAC,CAAC;SAC/D;QACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,aAAa;YACtB,KAAK,kCACA,IAAA,gCAAgB,EAAC,MAAA,MAAA,MAAM,CAAC,UAAU,0CAAE,gBAAgB,0CAAE,SAAS,EAAE,aAAa,CAAC,KAClF,IAAI,EAAE,IAAA,sCAAyB,EAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,GACrE;SACF;QACD,MAAM,EAAE;YACN,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,MAAA,MAAM,CAAC,UAAU,0CAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;SAC/E;QACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;SACtE;QACD,SAAS,EAAG,MAAsC,CAAC,SAAS;KAC7D,CAAC;AACJ,CAAC;AAED,SAAgB,gBAAgB,CAC9B,QAAgB,EAChB,WAA8B,EAC9B,aAA6C,EAC7C,gBAAwB;;IAExB,SAAS,UAAU,CAAC,IAAY,EAAE,WAA8B;QAC9D,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC;QACnC,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,OAAO,GAAG,IAAI,IAAI,gBAAgB,GAAG,CAAC;IACxC,CAAC;IAED,SAAS,cAAc,CAAC,IAAY,EAAE,WAA8B;QAClE,MAAM,EAAE,eAAe,EAAE,GAAG,WAAW,CAAC;QACxC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU;aACtC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;aACrE,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,OAAO,GAAG,eAAe,IAAI,IAAI,IAAI,UAAU,GAAG,CAAC;IACrD,CAAC;IAED,OAAO;QACL,GAAG,EAAE,IAAA,iCAAiB,EAAC,WAAW,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QACxE,YAAY,EAAE,gBAAgB;QAC9B,OAAO,EAAE,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAC;QAC1C,SAAS,EAAE;YACT,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,WAAW;YACpB,KAAK,EAAE,CAAC,cAAc,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;SAC/C;QACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;SAChF;QACD,MAAM,EAAE;YACN,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,MAAA,WAAW,CAAC,UAAU,0CAAE,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;SACpF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,YAA0B,EAAE,KAAsB;;IACvE,MAAM,eAAe,GAAG,MAAA,YAAY,CAAC,UAAU,0CAAE,gBAAgB,CAAC,IAAI,CACpE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAChE,CAAC;IACF,uCACK,IAAA,gCAAgB,EAAC,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,SAAS,EAAE,sCAAyB,CAAC,KAC1E,IAAI,EAAE,KAAK,CAAC,IAAI,EAChB,IAAI,EAAE,IAAA,sCAAyB,EAAC,KAAK,CAAC,aAAa,CAAC,cAAc,CAAC,IACnE;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,MAAwB;IACzC,uCACK,IAAA,gCAAgB,EAAC,MAAM,CAAC,SAAS,EAAE,sCAAyB,CAAC,KAChE,IAAI,EAAE,IAAA,sCAAyB,EAAC,MAAM,CAAC,aAAa,CAAC,IACrD;AACJ,CAAC"}

package/lib/adapters/references.d.ts

@@ -1,4 +1,4 @@
-import { RenderableContent, StringOrLink } from '../templating/types';
+import { RenderableContent, StringOrLink } from '../core/renderable/types';
 export type GetRenderableContentByTypeName = (typeName: string) => StringOrLink;
 export declare const linkFromTypeNameGenerator: GetRenderableContentByTypeName;
 export declare function replaceInlineReferences(text: string, linkReplacer?: GetRenderableContentByTypeName, emailReplacer?: GetRenderableContentByTypeName): RenderableContent[];

package/lib/adapters/references.js

@@ -3,7 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.replaceInlineEmails = exports.replaceInlineReferences = exports.linkFromTypeNameGenerator = void 0;
+exports.linkFromTypeNameGenerator = void 0;
+exports.replaceInlineReferences = replaceInlineReferences;
+exports.replaceInlineEmails = replaceInlineEmails;
 const class_file_generatorHelper_1 = __importDefault(require("../transpiler/markdown/class-file-generatorHelper"));
 exports.linkFromTypeNameGenerator = class_file_generatorHelper_1.default.getRenderableLinkByTypeName;
 function defaultGetEmailByReference(email) {
@@ -15,7 +17,6 @@ function defaultGetEmailByReference(email) {
 function replaceInlineReferences(text, linkReplacer = exports.linkFromTypeNameGenerator, emailReplacer = defaultGetEmailByReference) {
     return replaceInlineEmails(replaceInlineLinks([text], linkReplacer), emailReplacer);
 }
-exports.replaceInlineReferences = replaceInlineReferences;
 function replaceInlineLinks(renderableContents, getLinkByTypeName) {
     return renderableContents.flatMap((renderableContent) => inlineLinkContent(renderableContent, getLinkByTypeName));
 }
@@ -32,7 +33,6 @@ function inlineLinkContent(renderableContent, getLinkByTypeName) {
 function replaceInlineEmails(renderableContents, getLinkByTypeName) {
     return renderableContents.flatMap((renderableContent) => inlineEmailContent(renderableContent, getLinkByTypeName));
 }
-exports.replaceInlineEmails = replaceInlineEmails;
 function inlineEmailContent(renderableContent, getLinkByTypeName) {
     if (typeof renderableContent !== 'string') {
         return [renderableContent];

package/lib/adapters/references.js.map

@@ -1 +1 @@
-{"version":3,"file":"references.js","sourceRoot":"","sources":["../../src/adapters/references.ts"],"names":[],"mappings":";;;;;;AAAA,mHAAyF;AAK5E,QAAA,yBAAyB,GACpC,oCAAwB,CAAC,2BAA2B,CAAC;AAEvD,SAAS,0BAA0B,CAAC,KAAa;IAC/C,OAAO;QACL,KAAK,EAAE,KAAK;QACZ,GAAG,EAAE,UAAU,KAAK,EAAE;KACvB,CAAC;AACJ,CAAC;AAED,SAAgB,uBAAuB,CACrC,IAAY,EACZ,eAA+C,iCAAyB,EACxE,gBAAgD,0BAA0B;IAE1E,OAAO,mBAAmB,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,EAAE,aAAa,CAAC,CAAC;AACtF,CAAC;AAND,0DAMC;AAED,SAAS,kBAAkB,CACzB,kBAAuC,EACvC,iBAAiD;IAEjD,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC,CAAC;AACpH,CAAC;AAED,SAAS,iBAAiB,CACxB,iBAAoC,EACpC,iBAAiD;IAEjD,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE;QACzC,OAAO,CAAC,iBAAiB,CAAC,CAAC;KAC5B;IAED,MAAM,IAAI,GAAG,iBAAiB,CAAC;IAE/B,wDAAwD;IACxD,MAAM,eAAe,GAAG,2BAA2B,CAAC;IACpD,MAAM,OAAO,GAAG,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAC7C,OAAO,wBAAwB,CAAC,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AACpE,CAAC;AAED,SAAgB,mBAAmB,CACjC,kBAAuC,EACvC,iBAAiD;IAEjD,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,kBAAkB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC,CAAC;AACrH,CAAC;AALD,kDAKC;AAED,SAAS,kBAAkB,CACzB,iBAAoC,EACpC,iBAAiD;IAEjD,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE;QACzC,OAAO,CAAC,iBAAiB,CAAC,CAAC;KAC5B;IAED,MAAM,IAAI,GAAG,iBAAiB,CAAC;IAE/B,uDAAuD;IACvD,MAAM,eAAe,GAAG,gBAAgB,CAAC;IACzC,MAAM,OAAO,GAAG,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAC7C,OAAO,wBAAwB,CAAC,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AACpE,CAAC;AAED,SAAS,KAAK,CAAC,KAAa,EAAE,IAAY;IACxC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3C,IAAI,KAAK,CAAC;IACV,MAAM,OAAO,GAAG,EAAE,CAAC;IAEnB,GAAG;QACD,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,KAAK,EAAE;YACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACrB;KACF,QAAQ,KAAK,EAAE;IAEhB,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,wBAAwB,CAAC,OAA0B,EAAE,IAAY,EAAE,MAAsC;IAChH,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;QACxB,OAAO,CAAC,IAAI,CAAC,CAAC;KACf;IAED,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;QAC3B,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAC1B,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAE/B,yEAAyE;QACzE,2DAA2D;QAC3D,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;QAC5D,IAAI,CAAC,aAAa,EAAE;YAClB,SAAS;SACV;QACD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;QAEnC,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC;KAC5B;IAED,IAAI,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE;QAC3B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;KACpC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"references.js","sourceRoot":"","sources":["../../src/adapters/references.ts"],"names":[],"mappings":";;;;;;AAeA,0DAMC;AAyBD,kDAKC;AAnDD,mHAAyF;AAK5E,QAAA,yBAAyB,GACpC,oCAAwB,CAAC,2BAA2B,CAAC;AAEvD,SAAS,0BAA0B,CAAC,KAAa;IAC/C,OAAO;QACL,KAAK,EAAE,KAAK;QACZ,GAAG,EAAE,UAAU,KAAK,EAAE;KACvB,CAAC;AACJ,CAAC;AAED,SAAgB,uBAAuB,CACrC,IAAY,EACZ,eAA+C,iCAAyB,EACxE,gBAAgD,0BAA0B;IAE1E,OAAO,mBAAmB,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,EAAE,aAAa,CAAC,CAAC;AACtF,CAAC;AAED,SAAS,kBAAkB,CACzB,kBAAuC,EACvC,iBAAiD;IAEjD,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC,CAAC;AACpH,CAAC;AAED,SAAS,iBAAiB,CACxB,iBAAoC,EACpC,iBAAiD;IAEjD,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE,CAAC;QAC1C,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,IAAI,GAAG,iBAAiB,CAAC;IAE/B,wDAAwD;IACxD,MAAM,eAAe,GAAG,2BAA2B,CAAC;IACpD,MAAM,OAAO,GAAG,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAC7C,OAAO,wBAAwB,CAAC,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AACpE,CAAC;AAED,SAAgB,mBAAmB,CACjC,kBAAuC,EACvC,iBAAiD;IAEjD,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,EAAE,CAAC,kBAAkB,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC,CAAC;AACrH,CAAC;AAED,SAAS,kBAAkB,CACzB,iBAAoC,EACpC,iBAAiD;IAEjD,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE,CAAC;QAC1C,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,IAAI,GAAG,iBAAiB,CAAC;IAE/B,uDAAuD;IACvD,MAAM,eAAe,GAAG,gBAAgB,CAAC;IACzC,MAAM,OAAO,GAAG,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAC7C,OAAO,wBAAwB,CAAC,OAAO,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC;AACpE,CAAC;AAED,SAAS,KAAK,CAAC,KAAa,EAAE,IAAY;IACxC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3C,IAAI,KAAK,CAAC;IACV,MAAM,OAAO,GAAG,EAAE,CAAC;IAEnB,GAAG,CAAC;QACF,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,QAAQ,KAAK,EAAE;IAEhB,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,wBAAwB,CAAC,OAA0B,EAAE,IAAY,EAAE,MAAsC;IAChH,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAC1B,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAE/B,yEAAyE;QACzE,2DAA2D;QAC3D,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;QAC5D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,SAAS;QACX,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;QAEnC,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC;IAC7B,CAAC;IAED,IAAI,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC5B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/adapters/type-utils.d.ts

@@ -1,2 +1,2 @@
-import { EmptyLine, RenderableContent } from '../templating/types';
+import { EmptyLine, RenderableContent } from '../core/renderable/types';
 export declare function isEmptyLine(content: RenderableContent): content is EmptyLine;

package/lib/adapters/type-utils.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isEmptyLine = void 0;
+exports.isEmptyLine = isEmptyLine;
 function isEmptyLine(content) {
     return Object.keys(content).includes('type') && content.type === 'empty-line';
 }
-exports.isEmptyLine = isEmptyLine;
 //# sourceMappingURL=type-utils.js.map

package/lib/adapters/type-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"type-utils.js","sourceRoot":"","sources":["../../src/adapters/type-utils.ts"],"names":[],"mappings":";;;AAEA,SAAgB,WAAW,CAAC,OAA0B;IACpD,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAK,OAA4B,CAAC,IAAI,KAAK,YAAY,CAAC;AACtG,CAAC;AAFD,kCAEC"}
+{"version":3,"file":"type-utils.js","sourceRoot":"","sources":["../../src/adapters/type-utils.ts"],"names":[],"mappings":";;AAEA,kCAEC;AAFD,SAAgB,WAAW,CAAC,OAA0B;IACpD,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAK,OAA4B,CAAC,IAAI,KAAK,YAAY,CAAC;AACtG,CAAC"}

package/lib/application/Apexdocs.js.map

@@ -1 +1 @@
-{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;;;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAmD;AACnD,0EAAkD;AAClD,wDAAoD;AACpD,wEAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAE9D;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;QACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QAEvD,MAAM,KAAK,GAAiB,EAAE,CAAC;QAC/B,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,IAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YACnE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE7C,gBAAgB;QAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/D,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;SACJ;aAAM;YACL,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;SAC9D;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AAvDH,4BAgEC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACjF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
+{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;;;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAmD;AACnD,0EAAkD;AAClD,wDAAoD;AACpD,wEAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAE9D;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;QACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QAEvD,MAAM,KAAK,GAAiB,EAAE,CAAC;QAC/B,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,IAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YACnE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE7C,gBAAgB;QAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YAChE,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;QACL,CAAC;aAAM,CAAC;YACN,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;QAC/D,CAAC;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AAvDH,4BAgEC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/lib/cli/generate.js

@@ -30,9 +30,10 @@ const Apexdocs_1 = require("../application/Apexdocs");
 const cosmiconfig_1 = require("cosmiconfig");
 const result = (0, cosmiconfig_1.cosmiconfig)('apexdocs').search();
 result.then((config) => {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c;
     yargs.config(config === null || config === void 0 ? void 0 : config.config);
-    let argv = yargs.options({
+    let argv = yargs
+        .options({
         sourceDir: {
             type: 'string',
             alias: 's',
@@ -52,7 +53,8 @@ result.then((config) => {
             describe: 'Whether .cls classes will be searched for recursively in the directory provided.',
         },
         scope: {
-            type: 'array',
+            type: 'string',
+            array: true,
             alias: 'p',
             default: ['global'],
             describe: 'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
@@ -119,7 +121,8 @@ result.then((config) => {
             type: 'string',
             describe: 'Allows you to specify the root documentation directory where the files are being generated. This can be helpful when embedding the generated docs into an existing site so that the links are generated correctly.',
         },
-    }).argv;
+    })
+        .parseSync();
     if (config) {
         argv = Object.assign(Object.assign({}, config.config), argv);
     }
@@ -142,9 +145,6 @@ result.then((config) => {
         onAfterProcess: (_a = config === null || config === void 0 ? void 0 : config.config) === null || _a === void 0 ? void 0 : _a.onAfterProcess,
         onBeforeFileWrite: (_b = config === null || config === void 0 ? void 0 : config.config) === null || _b === void 0 ? void 0 : _b.onBeforeFileWrite,
         frontMatterHeader: (_c = config === null || config === void 0 ? void 0 : config.config) === null || _c === void 0 ? void 0 : _c.frontMatterHeader,
-        singleFile: (_d = config === null || config === void 0 ? void 0 : config.config) === null || _d === void 0 ? void 0 : _d.singleFile,
-        fileName: (_e = config === null || config === void 0 ? void 0 : config.config) === null || _e === void 0 ? void 0 : _e.fileName,
-        templateFilePath: (_f = config === null || config === void 0 ? void 0 : config.config) === null || _f === void 0 ? void 0 : _f.templateFilePath,
     });
     try {
         Apexdocs_1.Apexdocs.generate();

package/lib/cli/generate.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6CAA+B;AAE/B,0CAAuC;AACvC,sDAAmD;AAEnD,6CAA0C;AAE1C,MAAM,MAAM,GAAG,IAAA,yBAAW,EAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;AAChD,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;;IACrB,KAAK,CAAC,MAAM,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,CAAC;IAC7B,IAAI,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;QACvB,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,+DAA+D;SAC1E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,kEAAkE;SAC7E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,kFAAkF;SAC7F;QACD,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,QAAQ,CAAC;YACnB,QAAQ,EACN,sHAAsH;gBACtH,4HAA4H;gBAC5H,0IAA0I;SAC7I;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,QAAQ;YACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,CAAC;YAC3D,QAAQ,EACN,4EAA4E;gBAC5E,yEAAyE;SAC5E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,0DAA0D;SACrE;QACD,gBAAgB,EAAE;YAChB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,qEAAqE;SAChF;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,QAAQ,EACN,sGAAsG;gBACtG,kHAAkH;gBAClH,0GAA0G;gBAC1G,iDAAiD;SACpD;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,iGAAiG;SAC5G;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qFAAqF;YAC/F,OAAO,EAAE,SAAS;SACnB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,+HAA+H;gBAC/H,iFAAiF;SACpF;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qGAAqG;YAC/G,OAAO,EAAE,SAAS;SACnB;QACD,yBAAyB,EAAE;YACzB,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,KAAK;SACf;QACD,eAAe,EAAE;YACf,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,kGAAkG;YAC5G,OAAO,EAAE,KAAK;SACf;QACD,oBAAoB,EAAE;YACpB,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,oNAAoN;SACvN;KACF,CAAC,CAAC,IAAI,CAAC;IAER,IAAI,MAAM,EAAE;QACV,IAAI,mCAAQ,MAAM,CAAC,MAAM,GAAK,IAAI,CAAE,CAAC;KACtC;IAED,mBAAQ,CAAC,KAAK,CAAC;QACb,eAAe,EAAE,IAAI,CAAC,SAAS;QAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;QACzD,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;QACzD,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,OAAO,EAAE,IAAI,CAAC,oBAAoB;QAClC,cAAc,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,cAAc;QAC9C,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;QACpD,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;QACpD,UAAU,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,UAAU;QACtC,QAAQ,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,QAAQ;QAClC,gBAAgB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,gBAAgB;KACnD,CAAC,CAAC;IAEH,IAAI;QACF,mBAAQ,CAAC,QAAQ,EAAE,CAAC;KACrB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC,CAAC,CAAC"}
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6CAA+B;AAE/B,0CAAuC;AACvC,sDAAmD;AAEnD,6CAA0C;AAE1C,MAAM,MAAM,GAAG,IAAA,yBAAW,EAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;AAChD,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;;IACrB,KAAK,CAAC,MAAM,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,CAAC;IAC7B,IAAI,IAAI,GAAG,KAAK;SACb,OAAO,CAAC;QACP,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,+DAA+D;SAC1E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,kEAAkE;SAC7E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,kFAAkF;SAC7F;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,QAAQ,CAAC;YACnB,QAAQ,EACN,sHAAsH;gBACtH,4HAA4H;gBAC5H,0IAA0I;SAC7I;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,QAAQ;YACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,CAAC;YAC3D,QAAQ,EACN,4EAA4E;gBAC5E,yEAAyE;SAC5E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,0DAA0D;SACrE;QACD,gBAAgB,EAAE;YAChB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,qEAAqE;SAChF;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,QAAQ,EACN,sGAAsG;gBACtG,kHAAkH;gBAClH,0GAA0G;gBAC1G,iDAAiD;SACpD;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,iGAAiG;SAC5G;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qFAAqF;YAC/F,OAAO,EAAE,SAAS;SACnB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,+HAA+H;gBAC/H,iFAAiF;SACpF;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qGAAqG;YAC/G,OAAO,EAAE,SAAS;SACnB;QACD,yBAAyB,EAAE;YACzB,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,KAAK;SACf;QACD,eAAe,EAAE;YACf,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,kGAAkG;YAC5G,OAAO,EAAE,KAAK;SACf;QACD,oBAAoB,EAAE;YACpB,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,oNAAoN;SACvN;KACF,CAAC;SACD,SAAS,EAAE,CAAC;IAEf,IAAI,MAAM,EAAE,CAAC;QACX,IAAI,mCAAQ,MAAM,CAAC,MAAM,GAAK,IAAI,CAAE,CAAC;IACvC,CAAC;IAED,mBAAQ,CAAC,KAAK,CAAC;QACb,eAAe,EAAE,IAAI,CAAC,SAAS;QAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;QACzD,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;QACzD,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,OAAO,EAAE,IAAI,CAAC,oBAAoB;QAClC,cAAc,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,cAAc;QAC9C,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;QACpD,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;KACrD,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,mBAAQ,CAAC,QAAQ,EAAE,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC"}

package/lib/core/generate-docs.d.ts

@@ -0,0 +1,23 @@
+import { Type } from '@cparra/apex-reflection';
+import * as E from 'fp-ts/Either';
+export declare const documentType: (type: Type, linkGenerator: import("../adapters/references").GetRenderableContentByTypeName, namespace?: string | undefined) => string;
+export type DocumentationBundle = {
+    format: 'markdown';
+    referenceGuide: string;
+    docs: DocOutput[];
+};
+type DocumentationConfig = {
+    scope: string[];
+    outputDir: string;
+    namespace?: string;
+    sortMembersAlphabetically?: boolean;
+    defaultGroupName: string;
+    referenceGuideTemplate: string;
+};
+type DocOutput = {
+    docContents: string;
+    typeName: string;
+    type: 'class' | 'interface' | 'enum';
+};
+export declare function generateDocs(input: string[], config?: Partial<DocumentationConfig>): E.Either<string[], DocumentationBundle>;
+export {};