@cparra/apexdocs 2.24.0 → 2.25.0-alpha.1

package/lib/adapters/apex-types.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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, linkGenerator, baseHeadingLevel) {
+    function getHeading(type) {
+        const suffixMap = {
+            class: 'Class',
+            interface: 'Interface',
+            enum: 'Enum',
+        };
+        return `${type.name} ${suffixMap[type.type_name]}`;
+    }
+    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({}, getRenderable()), { namespace });
+}
+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 }));
+            }),
+        } });
+}
+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)),
+        } });
+}
+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),
+    };
+}
+//# sourceMappingURL=apex-types.js.map

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

@@ -0,0 +1 @@
+{"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

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

package/lib/adapters/documentables.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adaptDescribable = adaptDescribable;
+exports.adaptDocumentable = adaptDocumentable;
+const references_1 = require("./references");
+const type_utils_1 = require("./type-utils");
+function adaptDescribable(describable, linkGenerator) {
+    function describableToRenderableContent(describable) {
+        if (!describable) {
+            return;
+        }
+        return (describable
+            .map((line) => [
+            ...(0, references_1.replaceInlineReferences)(line, linkGenerator),
+            {
+                type: 'empty-line',
+            },
+        ])
+            .flatMap((line) => line)
+            // If the last element is an empty line, remove it
+            .filter((line, index, lines) => !((0, type_utils_1.isEmptyLine)(line) && index === lines.length - 1)));
+    }
+    return {
+        description: describableToRenderableContent(describable),
+    };
+}
+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, 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;
+    }
+    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) });
+}
+//# sourceMappingURL=documentables.js.map

package/lib/adapters/documentables.js.map

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adaptFieldOrProperty = adaptFieldOrProperty;
+const documentables_1 = require("./documentables");
+const references_1 = require("./references");
+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()],
+        },
+    };
+}
+//# sourceMappingURL=fields-and-properties.js.map

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,5 @@
+import { ConstructorMirror, MethodMirror } from '@cparra/apex-reflection';
+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

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adaptMethod = adaptMethod;
+exports.adaptConstructor = adaptConstructor;
+const documentables_1 = require("./documentables");
+const references_1 = require("./references");
+function adaptMethod(method, linkGenerator, baseHeadingLevel) {
+    var _a, _b, _c;
+    function buildTitle(method) {
+        const { name, parameters } = method;
+        const parametersString = parameters.map((param) => param.name).join(', ');
+        return `${name}(${parametersString})`;
+    }
+    function buildSignature(method) {
+        const { access_modifier, typeReference, name, memberModifiers } = method;
+        const parameters = method.parameters
+            .map((param) => `${param.typeReference.rawDeclaration} ${param.name}`)
+            .join(', ');
+        const members = memberModifiers.length > 0 ? `${memberModifiers.join(' ')} ` : '';
+        return `${access_modifier} ${members}${typeReference.rawDeclaration} ${name}(${parameters})`;
+    }
+    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,
+    };
+}
+function adaptConstructor(typeName, constructor, linkGenerator, baseHeadingLevel) {
+    var _a;
+    function buildTitle(name, constructor) {
+        const { parameters } = constructor;
+        const parametersString = parameters.map((param) => param.name).join(', ');
+        return `${name}(${parametersString})`;
+    }
+    function buildSignature(name, constructor) {
+        const { access_modifier } = constructor;
+        const parameters = constructor.parameters
+            .map((param) => `${param.typeReference.rawDeclaration} ${param.name}`)
+            .join(', ');
+        return `${access_modifier} ${name}(${parameters})`;
+    }
+    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)),
+        },
+    };
+}
+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, 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, references_1.linkFromTypeNameGenerator)), { type: (0, references_1.linkFromTypeNameGenerator)(thrown.exceptionName) });
+}
+//# sourceMappingURL=methods-and-constructors.js.map

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,5 @@
+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[];
+export declare function replaceInlineEmails(renderableContents: RenderableContent[], getLinkByTypeName: GetRenderableContentByTypeName): RenderableContent[];

package/lib/adapters/references.js

@@ -0,0 +1,82 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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) {
+    return {
+        title: email,
+        url: `mailto:${email}`,
+    };
+}
+function replaceInlineReferences(text, linkReplacer = exports.linkFromTypeNameGenerator, emailReplacer = defaultGetEmailByReference) {
+    return replaceInlineEmails(replaceInlineLinks([text], linkReplacer), emailReplacer);
+}
+function replaceInlineLinks(renderableContents, getLinkByTypeName) {
+    return renderableContents.flatMap((renderableContent) => inlineLinkContent(renderableContent, getLinkByTypeName));
+}
+function inlineLinkContent(renderableContent, getLinkByTypeName) {
+    if (typeof renderableContent !== 'string') {
+        return [renderableContent];
+    }
+    const text = renderableContent;
+    // Matches either `<<ClassName>>` or `{@link ClassName}`
+    const linkFormatRegEx = '{@link (.*?)}|<<([^>]+)>>';
+    const matches = match(linkFormatRegEx, text);
+    return createRenderableContents(matches, text, getLinkByTypeName);
+}
+function replaceInlineEmails(renderableContents, getLinkByTypeName) {
+    return renderableContents.flatMap((renderableContent) => inlineEmailContent(renderableContent, getLinkByTypeName));
+}
+function inlineEmailContent(renderableContent, getLinkByTypeName) {
+    if (typeof renderableContent !== 'string') {
+        return [renderableContent];
+    }
+    const text = renderableContent;
+    // Parsing references using the format '{@email email}'
+    const linkFormatRegEx = '{@email (.*?)}';
+    const matches = match(linkFormatRegEx, text);
+    return createRenderableContents(matches, text, getLinkByTypeName);
+}
+function match(regex, text) {
+    const expression = new RegExp(regex, 'gi');
+    let match;
+    const matches = [];
+    do {
+        match = expression.exec(text);
+        if (match) {
+            matches.push(match);
+        }
+    } while (match);
+    return matches;
+}
+function createRenderableContents(matches, text, linker) {
+    if (matches.length === 0) {
+        return [text];
+    }
+    const result = [];
+    let lastIndex = 0;
+    for (const match of matches) {
+        const index = match.index;
+        const length = match[0].length;
+        // loop through the matches (skip the first one, which is the full match)
+        // until we find the first capturing group that has a value
+        const capturedGroup = match.slice(1).find((group) => group);
+        if (!capturedGroup) {
+            continue;
+        }
+        result.push(text.slice(lastIndex, index));
+        result.push(linker(capturedGroup));
+        lastIndex = index + length;
+    }
+    if (lastIndex < text.length) {
+        result.push(text.slice(lastIndex));
+    }
+    return result;
+}
+//# sourceMappingURL=references.js.map

package/lib/adapters/references.js.map

@@ -0,0 +1 @@
+{"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

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

package/lib/adapters/type-utils.js

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

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

@@ -0,0 +1 @@
+{"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.d.ts

@@ -1,13 +1,13 @@
-import { ReflectionResult } from '@cparra/apex-reflection';
-import ApexBundle from '../model/apex-bundle';
-/**
- * Application entry-point to generate documentation out of Apex source files.
- */
-export declare class Apexdocs {
-    /**
-     * Generates documentation out of Apex source files.
-     */
-    static generate(): void;
-    private static filterByScopes;
-    static _reflectionWithLogger: (apexBundle: ApexBundle) => ReflectionResult;
-}
+import { ReflectionResult } from '@cparra/apex-reflection';
+import ApexBundle from '../model/apex-bundle';
+/**
+ * Application entry-point to generate documentation out of Apex source files.
+ */
+export declare class Apexdocs {
+    /**
+     * Generates documentation out of Apex source files.
+     */
+    static generate(): void;
+    private static filterByScopes;
+    static _reflectionWithLogger: (apexBundle: ApexBundle) => ReflectionResult;
+}