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

package/lib/__spec__/core/generating-interface-docs.spec.js

@@ -1,361 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const expect_extensions_1 = require("./expect-extensions");
-const generate_docs_1 = require("../../core/generate-docs");
-describe('Generates interface documentation', () => {
-    beforeAll(() => {
-        (0, expect_extensions_1.extendExpect)();
-    });
-    describe('documentation output', () => {
-        it('always returns markdown as the format', () => {
-            const input = `
-      public interface MyInterface {
-      }
-     `;
-            const result = (0, generate_docs_1.generateDocs)([input]);
-            (0, expect_extensions_1.assertEither)(result, (data) => expect(data.format).toBe('markdown'));
-        });
-        it('returns the name of the interface', () => {
-            const input = `
-      public interface MyInterface {
-      }
-      `;
-            const result = (0, generate_docs_1.generateDocs)([input]);
-            expect(result).documentationBundleHasLength(1);
-            (0, expect_extensions_1.assertEither)(result, (data) => expect(data.docs[0].typeName).toBe('MyInterface'));
-        });
-        it('returns the type as interface', () => {
-            const input = `
-      public interface MyInterface {
-      }
-      `;
-            const result = (0, generate_docs_1.generateDocs)([input]);
-            expect(result).documentationBundleHasLength(1);
-            (0, expect_extensions_1.assertEither)(result, (data) => expect(data.docs[0].type).toBe('interface'));
-        });
-        it('does not return interfaces out of scope', () => {
-            const input1 = `
-        global interface MyInterface {}
-      `;
-            const input2 = `
-        public interface AnotherInterface {}
-      `;
-            const result = (0, generate_docs_1.generateDocs)([input1, input2], { scope: ['global'] });
-            expect(result).documentationBundleHasLength(1);
-        });
-        it('does not return interfaces that have an @ignore in the docs', () => {
-            const input = `
-      /**
-        * @ignore
-        */
-      public interface MyInterface {}`;
-            const result = (0, generate_docs_1.generateDocs)([input]);
-            expect(result).documentationBundleHasLength(0);
-        });
-        it('does not return interface methods that have @ignore in the docs', () => {
-            const input = `
-      public interface MyInterface {
-        /**
-          * @ignore
-          */
-        void myMethod();
-      }`;
-            const result = (0, generate_docs_1.generateDocs)([input]);
-            expect(result).documentationBundleHasLength(1);
-            (0, expect_extensions_1.assertEither)(result, (data) => expect(data.docs[0].docContents).not.toContain('myMethod'));
-        });
-    });
-    describe('documentation content', () => {
-        describe('type level information', () => {
-            it('generates a heading with the interface name', () => {
-                const input = `
-        public interface MyInterface {}
-      `;
-                const output = `# MyInterface Interface`;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains(output));
-            });
-            it('displays type level annotations', () => {
-                const input = `
-        @NamespaceAccessible
-        public interface MyInterface {
-          @Deprecated
-          void myMethod();   
-        }
-       `;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('NAMESPACEACCESSIBLE'));
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('DEPRECATED'));
-            });
-            it('displays the description', () => {
-                const input = `
-          /**
-           * This is a description
-           */
-          public interface MyInterface {}
-         `;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('This is a description'));
-            });
-            it('display custom documentation tags', () => {
-                const input = `
-          /**
-           * @custom-tag My Value
-           */
-          public interface MyInterface {}
-        `;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('Custom Tag'));
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('My Value'));
-            });
-            it('displays the group', () => {
-                const input = `
-          /**
-           * @group MyGroup
-           */
-          public interface MyInterface {}`;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('Group'));
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('MyGroup'));
-            });
-            it('displays the author', () => {
-                const input = `
-          /**
-           * @author John Doe
-           */
-          public interface MyInterface {}`;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('Author'));
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('John Doe'));
-            });
-            it('displays the date', () => {
-                const input = `
-          /**
-           * @date 2021-01-01
-           */
-          public interface MyInterface {}`;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('Date'));
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('2021-01-01'));
-            });
-            it('displays descriptions', () => {
-                const input = `
-          /**
-            * @description This is a description
-            */
-          public interface MyInterface {}`;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('This is a description'));
-            });
-            it('displays descriptions with links', () => {
-                const input1 = `
-          /**
-            * @description This is a description with a {@link InterfaceRef} reference
-            */
-          public enum MyInterface {}
-          `;
-                const input2 = 'public interface InterfaceRef {}';
-                const result = (0, generate_docs_1.generateDocs)([input1, input2]);
-                expect(result).documentationBundleHasLength(2);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('This is a description with a [InterfaceRef](./InterfaceRef.md) reference'));
-            });
-            it('displays descriptions with emails', () => {
-                const input = `
-          /**
-            * @description This is a description with an {@email test@testerson.com} email
-            */
-          public interface MyInterface {}
-          `;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('This is a description with an [test@testerson.com](mailto:test@testerson.com) email'));
-            });
-            it('displays sees with accurately resolved links', () => {
-                const input1 = `
-          /**
-            * @see InterfaceRef
-            */
-          public interface MyInterface {}
-          `;
-                const input2 = 'public interface InterfaceRef {}';
-                const result = (0, generate_docs_1.generateDocs)([input1, input2]);
-                expect(result).documentationBundleHasLength(2);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('See'));
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('[InterfaceRef](./InterfaceRef.md)'));
-            });
-            it('displays sees without links when the reference is not found', () => {
-                const input = `
-          /**
-            * @see InterfaceRef
-            */
-          public interface MyInterface {}
-          `;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('See'));
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('InterfaceRef'));
-            });
-            it('displays the namespace if present in the config', () => {
-                const input = 'public interface MyInterface {}';
-                const result = (0, generate_docs_1.generateDocs)([input], { namespace: 'MyNamespace' });
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('## Namespace'));
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('MyNamespace'));
-            });
-            it('does not display the namespace if not present in the config', () => {
-                const input = 'public interface MyInterface {}';
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContainsNot('## Namespace'));
-            });
-            it('displays a mermaid diagram', () => {
-                const input = `
-          /**
-            * @mermaid
-            * graph TD
-            *   A[Square Rect] -- Link text --> B((Circle))
-            *   A --> C(Round Rect)
-            *   B --> D{Rhombus}
-            *   C --> D
-            */
-          public interface MyInterface {}
-          `;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('```mermaid'));
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('graph TD'));
-            });
-            it('displays an example code block', () => {
-                const input = `
-          /**
-            * @example
-            * public class MyClass {
-            *   public void myMethod() {
-            *     System.debug('Hello, World!');
-            *   }
-            * }
-            */
-          public interface MyInterface {}`;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('```apex'));
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('public class MyClass'));
-            });
-        });
-        describe('method information', () => {
-            it('displays the Method heading', () => {
-                const input = `
-        public interface MyInterface {
-          void myMethod();
-        }
-      `;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('## Methods'));
-            });
-            it('supports having mermaid diagrams in method descriptions', () => {
-                const input = `
-        public interface MyInterface {
-          /**
-            * @mermaid
-            * graph TD
-            *   A[Square Rect] -- Link text --> B((Circle))
-            *   A --> C(Round Rect)
-            *   B --> D{Rhombus}
-            *   C --> D
-            */
-          void myMethod();
-        }
-      `;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('```mermaid'));
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('graph TD'));
-            });
-            it('supports having example code blocks in method descriptions', () => {
-                const input = `
-        public interface MyInterface {
-          /**
-            * @example
-            * public class MyClass {
-            *   public void myMethod() {
-            *     System.debug('Hello, World!');
-            *   }
-            * }
-            */
-          void myMethod();
-        }
-      `;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('```apex'));
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('public class MyClass'));
-            });
-            it('has a signature section', () => {
-                const input = `
-        public interface MyInterface {
-          void myMethod();
-        }
-      `;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('### Signature'));
-            });
-            it('has a parameters section', () => {
-                const input = `
-        public interface MyInterface {
-          void myMethod(String param1, Integer param2);
-        }
-      `;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('### Parameters'));
-            });
-            it('has a return type section', () => {
-                const input = `
-        public interface MyInterface {
-          String myMethod();
-        }
-      `;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('### Return Type'));
-            });
-            it('has a throws section', () => {
-                const input = `
-        public interface MyInterface {
-          /**
-            * @throws MyException
-            */
-          void myMethod();
-        }
-      `;
-                const result = (0, generate_docs_1.generateDocs)([input]);
-                expect(result).documentationBundleHasLength(1);
-                (0, expect_extensions_1.assertEither)(result, (data) => expect(data).firstDocContains('### Throws'));
-            });
-            it('displays an "inherited" tag if the method was inherited from a different interface', () => {
-                const input1 = `
-        public interface MyInterface {
-          void myMethod();
-        }
-      `;
-                const input2 = `
-        public interface AnotherInterface extends MyInterface {}
-      `;
-                const result = (0, generate_docs_1.generateDocs)([input1, input2]);
-                expect(result).documentationBundleHasLength(2);
-                (0, expect_extensions_1.assertEither)(result, (data) => { var _a; return expect((_a = data.docs.find((doc) => doc.typeName === 'AnotherInterface')) === null || _a === void 0 ? void 0 : _a.docContents).toContain('Inherited'); });
-            });
-        });
-    });
-});
-//# sourceMappingURL=generating-interface-docs.spec.js.map

package/lib/__spec__/core/generating-interface-docs.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generating-interface-docs.spec.js","sourceRoot":"","sources":["../../../src/__spec__/core/generating-interface-docs.spec.ts"],"names":[],"mappings":";;AAAA,2DAAiE;AACjE,4DAAwD;AAExD,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;IACjD,SAAS,CAAC,GAAG,EAAE;QACb,IAAA,gCAAY,GAAE,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,KAAK,GAAG;;;MAGd,CAAC;YAED,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YACrC,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC3C,MAAM,KAAK,GAAG;;;OAGb,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;QACpF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;YACvC,MAAM,KAAK,GAAG;;;OAGb,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,MAAM,GAAG;;OAEd,CAAC;YAEF,MAAM,MAAM,GAAG;;OAEd,CAAC;YAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACrE,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;YACrE,MAAM,KAAK,GAAG;;;;sCAIkB,CAAC;YAEjC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;YACzE,MAAM,KAAK,GAAG;;;;;;QAMZ,CAAC;YAEH,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;YAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACrC,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;YACtC,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;gBACrD,MAAM,KAAK,GAAG;;OAEf,CAAC;gBAEA,MAAM,MAAM,GAAG,yBAAyB,CAAC;gBACzC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YACxE,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;gBACzC,MAAM,KAAK,GAAG;;;;;;QAMd,CAAC;gBAED,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,CAAC,CAAC;gBACrF,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;gBAClC,MAAM,KAAK,GAAG;;;;;UAKZ,CAAC;gBAEH,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC,CAAC;YACzF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;gBAC3C,MAAM,KAAK,GAAG;;;;;SAKb,CAAC;gBAEF,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;gBAC5E,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;YAC5E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;gBAC5B,MAAM,KAAK,GAAG;;;;0CAIoB,CAAC;gBAEnC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;gBACvE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;YAC3E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;gBAC7B,MAAM,KAAK,GAAG;;;;0CAIoB,CAAC;gBAEnC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACxE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;YAC5E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;gBAC3B,MAAM,KAAK,GAAG;;;;0CAIoB,CAAC;gBAEnC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;gBACtE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;gBAC/B,MAAM,KAAK,GAAG;;;;0CAIoB,CAAC;gBAEnC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC,CAAC;YACzF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;gBAC1C,MAAM,MAAM,GAAG;;;;;WAKZ,CAAC;gBAEJ,MAAM,MAAM,GAAG,kCAAkC,CAAC;gBAElD,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;gBAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAC5B,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,0EAA0E,CAAC,CAC1G,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;gBAC3C,MAAM,KAAK,GAAG;;;;;WAKX,CAAC;gBAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAC5B,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAC3B,qFAAqF,CACtF,CACF,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;gBACtD,MAAM,MAAM,GAAG;;;;;WAKZ,CAAC;gBAEJ,MAAM,MAAM,GAAG,kCAAkC,CAAC;gBAElD,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;gBAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,mCAAmC,CAAC,CAAC,CAAC;YACrG,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;gBACrE,MAAM,KAAK,GAAG;;;;;WAKX,CAAC;gBAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;gBACzD,MAAM,KAAK,GAAG,iCAAiC,CAAC;gBAEhD,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,EAAE,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC;gBACnE,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC;gBAC9E,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC;YAC/E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;gBACrE,MAAM,KAAK,GAAG,iCAAiC,CAAC;gBAEhD,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;YACnF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;gBACpC,MAAM,KAAK,GAAG;;;;;;;;;;WAUX,CAAC;gBAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;gBAC5E,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;YAC5E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;gBACxC,MAAM,KAAK,GAAG;;;;;;;;;0CASoB,CAAC;gBAEnC,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;gBACzE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC,CAAC;YACxF,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAClC,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;gBACrC,MAAM,KAAK,GAAG;;;;OAIf,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;gBACjE,MAAM,KAAK,GAAG;;;;;;;;;;;;OAYf,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;gBAC5E,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;YAC5E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;gBACpE,MAAM,KAAK,GAAG;;;;;;;;;;;;OAYf,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;gBACzE,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC,CAAC;YACxF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;gBACjC,MAAM,KAAK,GAAG;;;;OAIf,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC;YACjF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;gBAClC,MAAM,KAAK,GAAG;;;;OAIf,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,CAAC;YAClF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;gBACnC,MAAM,KAAK,GAAG;;;;OAIf,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC;YACnF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;gBAC9B,MAAM,KAAK,GAAG;;;;;;;OAOf,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,oFAAoF,EAAE,GAAG,EAAE;gBAC5F,MAAM,MAAM,GAAG;;;;OAIhB,CAAC;gBAEA,MAAM,MAAM,GAAG;;OAEhB,CAAC;gBAEA,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;gBAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,WAC5B,OAAA,MAAM,CAAC,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,kBAAkB,CAAC,0CAAE,WAAW,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA,EAAA,CACzG,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/__spec__/core/generating-reference-guide.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/__spec__/core/generating-reference-guide.spec.js

@@ -1,161 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const expect_extensions_1 = require("./expect-extensions");
-const generate_docs_1 = require("../../core/generate-docs");
-const function_1 = require("fp-ts/function");
-const E = __importStar(require("fp-ts/Either"));
-describe('Generates a Reference Guide', () => {
-    beforeAll(() => {
-        (0, expect_extensions_1.extendExpect)();
-    });
-    it('returns a reference guide with links to all other files', () => {
-        const input1 = `
-      public enum MyEnum {
-        VALUE1,
-        VALUE2
-      }
-      `;
-        const input2 = `
-      public class MyClass {}
-      `;
-        const result = (0, generate_docs_1.generateDocs)([input1, input2]);
-        expect(result).documentationBundleHasLength(2);
-        (0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('[MyEnum](./Miscellaneous/MyEnum.md)'));
-        (0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('[MyClass](./Miscellaneous/MyClass.md)'));
-    });
-    it('groups things under Miscellaneous if no group is provided', () => {
-        const input = `
-      public enum MyEnum {
-        VALUE1,
-        VALUE2
-      }
-      `;
-        const result = (0, generate_docs_1.generateDocs)([input]);
-        expect(result).documentationBundleHasLength(1);
-        (0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('## Miscellaneous'));
-    });
-    it('group things under the provided group', () => {
-        const input = `
-      /**
-        * @group MyGroup
-        */
-      public enum MyEnum {
-        VALUE1,
-        VALUE2
-      }
-      `;
-        const result = (0, generate_docs_1.generateDocs)([input]);
-        expect(result).documentationBundleHasLength(1);
-        (0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('## MyGroup'));
-    });
-    it('displays groups in alphabetical order', () => {
-        const input1 = `
-      /**
-        * @group ZGroup
-        */
-      public enum MyEnum {
-        VALUE1,
-        VALUE2
-      }
-      `;
-        const input2 = `
-      /**
-        * @group AGroup
-        */
-      public class MyClass {}
-      `;
-        const result = (0, generate_docs_1.generateDocs)([input1, input2]);
-        expect(result).documentationBundleHasLength(2);
-        (0, function_1.pipe)(result, E.map((data) => ({
-            aGroupIndex: data.referenceGuide.indexOf('## AGroup'),
-            zGroupIndex: data.referenceGuide.indexOf('## ZGroup'),
-        })), E.match(() => fail('Expected data'), (data) => expect(data.aGroupIndex).toBeLessThan(data.zGroupIndex)));
-    });
-    it('displays references within groups in alphabetical order', () => {
-        const input1 = `
-      /**
-        * @group Group1
-        */
-      public enum MyEnum {
-        VALUE1,
-        VALUE2
-      }
-      `;
-        const input2 = `
-      /**
-        * @group Group1
-        */
-      public class MyClass {}
-      `;
-        const result = (0, generate_docs_1.generateDocs)([input1, input2]);
-        expect(result).documentationBundleHasLength(2);
-        (0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('## Group1'));
-        (0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('MyClass'));
-        (0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('MyEnum'));
-    });
-    it('returns a reference guide with descriptions', () => {
-        const input1 = `
-      /**
-        * @description This is a description
-        */
-      public enum MyEnum {
-        VALUE1,
-        VALUE2
-      }
-      `;
-        const input2 = `
-      /**
-        * @description This is a description
-        */
-      public class MyClass {}
-      `;
-        const result = (0, generate_docs_1.generateDocs)([input1, input2]);
-        expect(result).documentationBundleHasLength(2);
-        (0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('This is a description'));
-    });
-    it('returns a reference guide with descriptions with links to all other files', () => {
-        const input1 = `
-      /**
-        * @description This is a description with a {@link MyClass}
-        * @group Group1
-        */
-      public enum MyEnum {
-        VALUE1,
-        VALUE2
-      }
-      `;
-        const input2 = `
-      /**
-        * @group Group2
-        */
-      public class MyClass {}
-      `;
-        const result = (0, generate_docs_1.generateDocs)([input1, input2]);
-        expect(result).documentationBundleHasLength(2);
-        (0, expect_extensions_1.assertEither)(result, (data) => expect(data.referenceGuide).toContain('with a [MyClass](./Group2/MyClass.md)'));
-    });
-});
-//# sourceMappingURL=generating-reference-guide.spec.js.map

package/lib/__spec__/core/generating-reference-guide.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generating-reference-guide.spec.js","sourceRoot":"","sources":["../../../src/__spec__/core/generating-reference-guide.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2DAAiE;AACjE,4DAAwD;AACxD,6CAAsC;AACtC,gDAAkC;AAElC,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;IAC3C,SAAS,CAAC,GAAG,EAAE;QACb,IAAA,gCAAY,GAAE,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,MAAM,GAAG;;;;;OAKZ,CAAC;QAEJ,MAAM,MAAM,GAAG;;OAEZ,CAAC;QAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAE/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,qCAAqC,CAAC,CAAC,CAAC;QAC7G,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,uCAAuC,CAAC,CAAC,CAAC;IACjH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,KAAK,GAAG;;;;;OAKX,CAAC;QAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,KAAK,GAAG;;;;;;;;OAQX,CAAC;QAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;IACtF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,MAAM,GAAG;;;;;;;;OAQZ,CAAC;QAEJ,MAAM,MAAM,GAAG;;;;;OAKZ,CAAC;QAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,eAAI,EACF,MAAM,EACN,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACf,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC;YACrD,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC;SACtD,CAAC,CAAC,EACH,CAAC,CAAC,KAAK,CACL,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,EAC3B,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAClE,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,MAAM,GAAG;;;;;;;;OAQZ,CAAC;QAEJ,MAAM,MAAM,GAAG;;;;;OAKZ,CAAC;QAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;QACnF,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;QACjF,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,MAAM,GAAG;;;;;;;;OAQZ,CAAC;QAEJ,MAAM,MAAM,GAAG;;;;;OAKZ,CAAC;QAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC,CAAC;IACjG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACnF,MAAM,MAAM,GAAG;;;;;;;;;OASZ,CAAC;QAEJ,MAAM,MAAM,GAAG;;;;;OAKZ,CAAC;QAEJ,MAAM,MAAM,GAAG,IAAA,4BAAY,EAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,gCAAY,EAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,uCAAuC,CAAC,CAAC,CAAC;IACjH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/adapters/apex-types.d.ts

@@ -1,7 +0,0 @@
-import { ClassMirror, EnumMirror, InterfaceMirror, Type } from '@cparra/apex-reflection';
-import { RenderableClass, RenderableEnum, RenderableInterface, Renderable } from '../core/renderable/types';
-import { GetRenderableContentByTypeName } from './references';
-export declare function typeToRenderableType(type: Type, linkGenerator: GetRenderableContentByTypeName, namespace?: string): Renderable;
-export declare function enumTypeToEnumSource(enumType: EnumMirror, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel?: number): RenderableEnum;
-export declare function interfaceTypeToInterfaceSource(interfaceType: InterfaceMirror, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel?: number): RenderableInterface;
-export declare function classTypeToClassSource(classType: ClassMirror, linkGenerator: GetRenderableContentByTypeName, baseHeadingLevel?: number): RenderableClass;