@cparra/apexdocs 2.5.1 → 2.6.0-beta.1

package/README.md

@@ -75,7 +75,8 @@ public class MyClass {
 
 ### Demo
 
-ApexDocs currently supports generating markdown files for Jekyll and Docsify sites, as well as generating plain markdown files.
+ApexDocs currently supports generating markdown files for Jekyll and Docsify sites, as well as generating plain markdown
+files.
 
 ### In the wild
 
@@ -114,16 +115,16 @@ apexdocs-generate
 
 The CLI supports the following parameters:
 
-| Parameter          | Alias | Description                                                                                                                              | Default         | Required |
-|--------------------|-------|------------------------------------------------------------------------------------------------------------------------------------------|-----------------|----------|
-| --sourceDir        | -s    | The directory location which contains your apex .cls classes.                                                                            | N/A             | Yes      |
-| --targetDir        | -t    | The directory location where documentation will be generated to.                                                                         | `docs`          | No       |
-| --recursive        | -r    | Whether .cls classes will be searched for recursively in the directory provided.                                                         | `true`          | No       |
-| --scope            | -p    | A list of scopes to document. Values should be separated by a space, e.g --scope public private                                          | `global`        | No       |
-| --targetGenerator  | -g    | Define the static file generator for which the documents will be created. Currently supports: `jekyll`, `docsify`, and `plain-markdown`. | `jekyll`        | No       |
-| --indexOnly        | N/A   | Defines whether only the index file should be generated.                                                                                 | `false`         | No       |
-| --defaultGroupName | N/A   | Defines the `@group` name to be used when a file does not specify it.                                                                    | `Miscellaneous` | No       |
-
+| Parameter          | Alias | Description                                                                                                                                                                                                                                                                                                                                                                 | Default         | Required |
+|--------------------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|----------|
+| --sourceDir        | -s    | The directory location which contains your apex .cls classes.                                                                                                                                                                                                                                                                                                               | N/A             | Yes      |
+| --targetDir        | -t    | The directory location where documentation will be generated to.                                                                                                                                                                                                                                                                                                            | `docs`          | No       |
+| --recursive        | -r    | Whether .cls classes will be searched for recursively in the directory provided.                                                                                                                                                                                                                                                                                            | `true`          | No       |
+| --scope            | -p    | A list of scopes to document. Values should be separated by a space, e.g --scope public private                                                                                                                                                                                                                                                                             | `global`        | No       |
+| --targetGenerator  | -g    | Define the static file generator for which the documents will be created. Currently supports: `jekyll`, `docsify`, and `plain-markdown`.                                                                                                                                                                                                                                    | `jekyll`        | No       |
+| --indexOnly        | N/A   | Defines whether only the index file should be generated.                                                                                                                                                                                                                                                                                                                    | `false`         | No       |
+| --defaultGroupName | N/A   | Defines the `@group` name to be used when a file does not specify it.                                                                                                                                                                                                                                                                                                       | `Miscellaneous` | No       |
+| --sanitizeHtml     | N/A   | When on, any special character within your ApexDocs is converted into its HTML code representation. This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" because otherwise the content within < and > would be treated as HTML tags and not shown in the output. Content in @example blocks are never sanitized. | true            | No       |
 
 ### Importing to your project
 
@@ -284,10 +285,11 @@ Email addresses can also be inlined linked by using the `{@email EMAIL_ADDRESS}`
 
 ### HTML support
 
-For the most part all HTML is sanitized. But there are some tags are allowed to have for the possibility of better
+For the most part all HTML is sanitized when the `--sanitizeHtml` flag is passed a true value (which is the default). 
+But there are some tags are allowed to have for the possibility of better
 styling long text.
 
-- Allowed tags are: `br`, `p`, `ul`, and `li`
+- Allowed tags are: `br`, `p`, `ul`, `li`, and `code`
 
 Example
 
@@ -304,6 +306,22 @@ class MyClass {
 }
 ```
 
+⚠️When the `--sanitizeHtml` flag is ON, any special character between code blocks (i.e. \```, \`, or `<code>`) will also be escaped.
+So if you have references to Apex generic collections (Set, List, or Maps) they will not look right, as the < and > symbols will be escaped.
+To prevent this you can turn the flag off, but be aware of the special considerations when doing this described below.
+
+---
+
+For full control over the output you can also turn off the `--sanitizeHtml` flag, which will allow you
+to have any desired HTML within your docs.
+
+⚠️When the `--sanitizeHtml` flag is OFF, references to Apex generic collections (Set, List or Maps) can be problematic
+as they will be treated as an HTML tag and not displayed. For example if you have something like `@description Returns a List<String>`
+the `<String>` portion will be treated as HTML and thus not appear on the page.
+
+To fix this issue, when not sanitizing HTML, you should wrap any code that contain special characters that can be treated as HTML within '`'
+or within `<code>` tags.
+
 ## Typescript
 
 ApexDocs provides all necessary type definitions.
@@ -311,4 +329,5 @@ ApexDocs provides all necessary type definitions.
 ---
 
 ## 1.X
+
 Looking for documentation for version 1.X? Please refer to its [branch](https://github.com/cesarParra/apexdocs/tree/1.x)

package/docs/Main/SampleClass.md

@@ -6,7 +6,9 @@
 
 `STATUS: ACTIVE`
 
-This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)              But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.              You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+             But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
+             You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
 
 
 **Group** Main
@@ -41,11 +43,13 @@ Constructs a SampleClass without any arguments. This relates to [SampleInterface
 **See** [SampleInterface](/Sample-Interfaces/SampleInterface.md)
 
 ###### Example
-```apex
+```
+apex
 // Example
 SampleClass sampleInstance = new SampleClass();
 ```
 
+
 ---
 ### Other
 ##### `SampleClass(String argument1, String argument2)`
@@ -116,11 +120,13 @@ String
 Empty string
 
 #### Example
-```apex
+```
+apex
 String result = SampleClass.testMethod();
 System.debug(result);
 ```
 
+
 ### `static anotherSampleMethod(String arg1)`
 
 Something here

package/docs/README.md

@@ -1,20 +1,33 @@
 # Classes
+## core-utils
+
+### [ClassWithDescriptionBlock](/core-utils/ClassWithDescriptionBlock.md)
+
+Simple Trigger Framework, integrated with [CodeControl](CodeControl).
+To use TriggerService for a given trigger,
+1.  Build a trigger handler class that extends [TriggerHelperBase](TriggerHelperBase), implementing any trigger stages (e.g., beforeInsert, afterUpdate, etc)
+needed by your trigger. Here is a List<String>.
+2.  In t…
 ## Main
 
 ### [GroupedClass](/Main/GroupedClass.md)
 
 Uses a block style apex doc
 
+
 ### [SampleClass](/Main/SampleClass.md)
 
-This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)              But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.              You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+             But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
+             You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+
 ## Miscellaneous
 
 ### [SampleClassWithoutModifier](/API/SampleClassWithoutModifier.md)
 
-
 ## Sample Interfaces
 
 ### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
 
 This is an interface description.
+

package/docs/core-utils/ClassWithDescriptionBlock.md

@@ -0,0 +1,36 @@
+# ClassWithDescriptionBlock
+
+Simple Trigger Framework, integrated with [CodeControl](CodeControl).
+To use TriggerService for a given trigger,
+1.  Build a trigger handler class that extends [TriggerHelperBase](TriggerHelperBase), implementing any trigger stages (e.g., beforeInsert, afterUpdate, etc)
+needed by your trigger. Here is a List<String>.
+2.  In the trigger, call `TriggerService.run()`, passing a new instance of your handler.
+```
+// TriggerHandler
+public class AccountHandler extends TriggerHelperBase {
+public override void afterInsert(List<SObject> newList) {
+// ... do trigger things
+}
+}
+// Trigger
+trigger AccountTrigger on Account (after insert) {
+TriggerService.run(new AccountHandler());
+}
+```
+Something else `<but>` outside.
+
+
+**Class** TriggerService
+
+
+**TestClass** TriggerService_Test
+
+
+**Group** core-utils
+
+
+**Author** Jason Clark
+
+
+**Date** 1/15/22
+

package/examples/force-app/main/default/classes/ClassWithDescriptionBlock.cls

@@ -0,0 +1,31 @@
+/**********************************************************
+@class          TriggerService
+@testClass      TriggerService_Test
+@group          core-utils
+@description    Simple Trigger Framework, integrated with <<CodeControl>>.
+
+To use TriggerService for a given trigger,
+1.  Build a trigger handler class that extends <<TriggerHelperBase>>, implementing any trigger stages (e.g., beforeInsert, afterUpdate, etc)
+    needed by your trigger. Here is a List<String>.
+2.  In the trigger, call `TriggerService.run()`, passing a new instance of your handler.
+
+```
+// TriggerHandler
+public class AccountHandler extends TriggerHelperBase {
+    public override void afterInsert(List<SObject> newList) {
+        // ... do trigger things
+    }
+}
+
+// Trigger
+trigger AccountTrigger on Account (after insert) {
+    TriggerService.run(new AccountHandler());
+}
+```
+
+Something else `<but>` outside.
+
+@author         Jason Clark
+@date           1/15/22
+***********************************************************/
+public class ClassWithDescriptionBlock {}

package/lib/cli/generate.js

@@ -47,6 +47,14 @@ const argv = yargs.options({
         default: 'Miscellaneous',
         describe: 'Defines the @group name to be used when a file does not specify it.',
     },
+    sanitizeHtml: {
+        type: 'boolean',
+        default: true,
+        describe: 'When on, any special character within your ApexDocs is converted into its HTML code representation. ' +
+            'This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" ' +
+            'because otherwise the content within < and > would be treated as HTML tags and not shown in the output. ' +
+            'Content in @example blocks are never sanitized.',
+    },
 }).argv;
 settings_1.Settings.build({
     sourceDirectory: argv.sourceDir,
@@ -56,6 +64,7 @@ settings_1.Settings.build({
     targetGenerator: argv.targetGenerator,
     indexOnly: argv.indexOnly,
     defaultGroupName: argv.defaultGroupName,
+    sanitizeHtml: argv.sanitizeHtml,
 });
 Apexdocs_1.Apexdocs.generate();
 //# sourceMappingURL=generate.js.map

package/lib/cli/generate.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;AACA,+BAA+B;AAE/B,0CAAyD;AACzD,sDAAmD;AAEnD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;IACzB,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,+DAA+D;KAC1E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,kEAAkE;KAC7E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,kFAAkF;KAC7F;IACD,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,CAAC,QAAQ,CAAC;QACnB,QAAQ,EACN,sHAAsH;YACtH,0HAA0H;KAC7H;IACD,eAAe,EAAE;QACf,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,QAAQ;QACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,CAAC;QAChD,QAAQ,EACN,mIAAmI;KACtI;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,0DAA0D;KACrE;IACD,gBAAgB,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,eAAe;QACxB,QAAQ,EAAE,qEAAqE;KAChF;CACF,CAAC,CAAC,IAAI,CAAC;AAER,mBAAQ,CAAC,KAAK,CAAC;IACb,eAAe,EAAE,IAAI,CAAC,SAAS;IAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,KAAK,EAAE,IAAI,CAAC,KAAK;IACjB,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;IACzD,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;CACxC,CAAC,CAAC;AAEH,mBAAQ,CAAC,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;AACA,+BAA+B;AAE/B,0CAAyD;AACzD,sDAAmD;AAEnD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;IACzB,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,+DAA+D;KAC1E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,kEAAkE;KAC7E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,kFAAkF;KAC7F;IACD,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,CAAC,QAAQ,CAAC;QACnB,QAAQ,EACN,sHAAsH;YACtH,0HAA0H;KAC7H;IACD,eAAe,EAAE;QACf,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,QAAQ;QACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,CAAC;QAChD,QAAQ,EACN,mIAAmI;KACtI;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,0DAA0D;KACrE;IACD,gBAAgB,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,eAAe;QACxB,QAAQ,EAAE,qEAAqE;KAChF;IACD,YAAY,EAAE;QACZ,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;QACb,QAAQ,EACN,sGAAsG;YACtG,kHAAkH;YAClH,0GAA0G;YAC1G,iDAAiD;KACpD;CACF,CAAC,CAAC,IAAI,CAAC;AAER,mBAAQ,CAAC,KAAK,CAAC;IACb,eAAe,EAAE,IAAI,CAAC,SAAS;IAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,KAAK,EAAE,IAAI,CAAC,KAAK;IACjB,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;IACzD,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;IACvC,YAAY,EAAE,IAAI,CAAC,YAAY;CAChC,CAAC,CAAC;AAEH,mBAAQ,CAAC,QAAQ,EAAE,CAAC"}

package/lib/model/file.js

@@ -2,8 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.File = void 0;
 const xss = require("xss");
+const settings_1 = require("../settings");
 const xssFilter = new xss.FilterXSS({
-    whiteList: { br: [], p: [], ul: [], li: [] },
+    whiteList: { br: [], p: [], ul: [], li: [], code: [], pre: [] },
 });
 class File {
     constructor(fileName, dir) {
@@ -15,7 +16,8 @@ class File {
         return this._contents;
     }
     addText(text, encodeHtml = true) {
-        const textToAdd = encodeHtml ? xssFilter.process(text) : text;
+        const shouldEncode = encodeHtml && settings_1.Settings.getInstance().sanitizeHtml;
+        const textToAdd = shouldEncode ? xssFilter.process(text) : text;
         this._contents += textToAdd;
         this.addBlankLine();
     }

package/lib/model/file.js.map

@@ -1 +1 @@
-{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/model/file.ts"],"names":[],"mappings":";;;AAAA,2BAA4B;AAE5B,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC;IAClC,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE;CAC7C,CAAC,CAAC;AAEH,MAAsB,IAAI;IAGxB,YAAmB,QAAgB,EAAS,GAAW;QAApC,aAAQ,GAAR,QAAQ,CAAQ;QAAS,QAAG,GAAH,GAAG,CAAQ;QAFvD,cAAS,GAAG,EAAE,CAAC;IAE2C,CAAC;IAI3D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QACrC,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC9D,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC;QAC5B,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;IACzB,CAAC;CACF;AApBD,oBAoBC"}
+{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/model/file.ts"],"names":[],"mappings":";;;AAAA,2BAA4B;AAC5B,0CAAuC;AAEvC,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC;IAClC,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE;CAChE,CAAC,CAAC;AAEH,MAAsB,IAAI;IAGxB,YAAmB,QAAgB,EAAS,GAAW;QAApC,aAAQ,GAAR,QAAQ,CAAQ;QAAS,QAAG,GAAH,GAAG,CAAQ;QAFvD,cAAS,GAAG,EAAE,CAAC;IAE2C,CAAC;IAI3D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QACrC,MAAM,YAAY,GAAG,UAAU,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,CAAC;QACvE,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAChE,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC;QAC5B,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;IACzB,CAAC;CACF;AArBD,oBAqBC"}

package/lib/model/markdown-file.js

@@ -23,13 +23,13 @@ class MarkdownFile extends file_1.File {
         super.addText(text, encodeHtml);
     }
     startCodeBlock() {
-        this._contents += '```';
+        this.addText('```');
         const sourceLanguage = 'apex';
         this._contents += sourceLanguage;
         this.addBlankLine();
     }
     endCodeBlock() {
-        this._contents += '```';
+        this.addText('```');
         this.addBlankLine();
     }
     addHorizontalRule() {

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

@@ -1 +1 @@
-{"version":3,"file":"markdown-file.js","sourceRoot":"","sources":["../../src/model/markdown-file.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAC9B,kGAAyF;AAEzF,MAAa,YAAa,SAAQ,WAAI;IACpC,aAAa;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,QAAQ,CAAC,IAAY,EAAE,KAAK,GAAG,CAAC;QAC9B,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE;YAC9B,KAAK,IAAI,GAAG,CAAC;SACd;QAED,KAAK,IAAI,GAAG,CAAC;QACb,KAAK,IAAI,IAAI,CAAC;QACd,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAEM,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QAC5C,IAAI,GAAG,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,GAAG,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC9C,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAClC,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,MAAM,cAAc,GAAG,MAAM,CAAC;QAC9B,IAAI,CAAC,SAAS,IAAI,cAAc,CAAC;QACjC,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,iBAAiB;QACf,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,eAAe,CAAC,GAAG,OAAiB;QAClC,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,IAAI,MAAM,GAAG,GAAG,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACpB,IAAI,CAAC,SAAS,IAAI,KAAK,GAAG,GAAG,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,GAAG,OAAiB;QAC9B,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,IAAI,MAAM,GAAG,GAAG,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,IAAY;QACtB,IAAI,CAAC,SAAS,IAAI,KAAK,IAAI,EAAE,CAAC;IAChC,CAAC;IAES,MAAM,CAAC,kBAAkB,CAAC,IAAY;QAC9C,oDAAoD;QACpD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC7C,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YACtC,MAAM,iBAAiB,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC3E,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,oCAAwB,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACvG,CAAC,EAAE;QAEH,+CAA+C;QAC/C,MAAM,eAAe,GAAG,eAAe,CAAC;QACxC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC;QACV,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,GAAG;YACD,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACF,QAAQ,KAAK,EAAE;QAEhB,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE;YAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,oCAAwB,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACvG;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAES,MAAM,CAAC,mBAAmB,CAAC,IAAY;QAC/C,+CAA+C;QAC/C,MAAM,eAAe,GAAG,gBAAgB,CAAC;QACzC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC;QACV,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,GAAG;YACD,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACF,QAAQ,KAAK,EAAE;QAEhB,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE;YAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,IAAI,YAAY,CAAC,CAAC,CAAC,YAAY,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SACzF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAhHD,oCAgHC"}
+{"version":3,"file":"markdown-file.js","sourceRoot":"","sources":["../../src/model/markdown-file.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAC9B,kGAAyF;AAEzF,MAAa,YAAa,SAAQ,WAAI;IACpC,aAAa;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,QAAQ,CAAC,IAAY,EAAE,KAAK,GAAG,CAAC;QAC9B,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE;YAC9B,KAAK,IAAI,GAAG,CAAC;SACd;QAED,KAAK,IAAI,GAAG,CAAC;QACb,KAAK,IAAI,IAAI,CAAC;QACd,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAEM,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QAC5C,IAAI,GAAG,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,GAAG,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAE9C,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAClC,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACpB,MAAM,cAAc,GAAG,MAAM,CAAC;QAC9B,IAAI,CAAC,SAAS,IAAI,cAAc,CAAC;QACjC,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACpB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,iBAAiB;QACf,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,eAAe,CAAC,GAAG,OAAiB;QAClC,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,IAAI,MAAM,GAAG,GAAG,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACpB,IAAI,CAAC,SAAS,IAAI,KAAK,GAAG,GAAG,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,GAAG,OAAiB;QAC9B,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,IAAI,MAAM,GAAG,GAAG,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,IAAY;QACtB,IAAI,CAAC,SAAS,IAAI,KAAK,IAAI,EAAE,CAAC;IAChC,CAAC;IAES,MAAM,CAAC,kBAAkB,CAAC,IAAY;QAC9C,oDAAoD;QACpD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC7C,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YACtC,MAAM,iBAAiB,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC3E,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,oCAAwB,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACvG,CAAC,EAAE;QAEH,+CAA+C;QAC/C,MAAM,eAAe,GAAG,eAAe,CAAC;QACxC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC;QACV,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,GAAG;YACD,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACF,QAAQ,KAAK,EAAE;QAEhB,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE;YAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,oCAAwB,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACvG;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAES,MAAM,CAAC,mBAAmB,CAAC,IAAY;QAC/C,+CAA+C;QAC/C,MAAM,eAAe,GAAG,gBAAgB,CAAC;QACzC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC;QACV,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,GAAG;YACD,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACF,QAAQ,KAAK,EAAE;QAEhB,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE;YAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,IAAI,YAAY,CAAC,CAAC,CAAC,YAAY,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SACzF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAjHD,oCAiHC"}

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

@@ -8,9 +8,11 @@ function declareType(markdownFile, typeMirror) {
         markdownFile.addBlankLine();
         markdownFile.addText(`\`${currentAnnotation.type.toUpperCase()}\``);
     });
-    if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.description) {
+    if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines) {
         markdownFile.addBlankLine();
-        markdownFile.addText(typeMirror.docComment.description);
+        for (const currentLine of typeMirror.docComment.descriptionLines) {
+            markdownFile.addText(currentLine);
+        }
         markdownFile.addBlankLine();
     }
     doc_comment_annotation_util_1.addCustomDocCommentAnnotations(markdownFile, typeMirror);

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

@@ -1 +1 @@
-{"version":3,"file":"type-declaration-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/type-declaration-util.ts"],"names":[],"mappings":";;;AACA,+EAA+E;AAG/E,SAAgB,WAAW,CAAC,YAA0B,EAAE,UAAgB;;IACtE,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,iBAA6B,EAAE,EAAE;QAC/D,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,KAAK,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,UAAI,UAAU,CAAC,UAAU,0CAAE,WAAW,EAAE;QACtC,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACxD,YAAY,CAAC,YAAY,EAAE,CAAC;KAC7B;IAED,4DAA8B,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;AAC3D,CAAC;AAbD,kCAaC"}
+{"version":3,"file":"type-declaration-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/type-declaration-util.ts"],"names":[],"mappings":";;;AACA,+EAA+E;AAG/E,SAAgB,WAAW,CAAC,YAA0B,EAAE,UAAgB;;IACtE,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,iBAA6B,EAAE,EAAE;QAC/D,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,KAAK,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,UAAI,UAAU,CAAC,UAAU,0CAAE,gBAAgB,EAAE;QAC3C,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,KAAK,MAAM,WAAW,IAAI,UAAU,CAAC,UAAU,CAAC,gBAAgB,EAAE;YAChE,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;SACnC;QACD,YAAY,CAAC,YAAY,EAAE,CAAC;KAC7B;IAED,4DAA8B,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;AAC3D,CAAC;AAfD,kCAeC"}

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MarkdownHomeFile = void 0;
 const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
 const markdown_file_1 = require("./markdown-file");
+const truncate_1 = require("../util/truncate");
 class MarkdownHomeFile extends markdown_file_1.MarkdownFile {
     constructor(fileName, types, headerContent) {
         super(fileName, '');
@@ -24,11 +25,14 @@ class MarkdownHomeFile extends markdown_file_1.MarkdownFile {
         });
     }
     addTypeEntry(typeMirror) {
-        var _a, _b;
+        var _a;
         this.addBlankLine();
         this.addTitle(class_file_generatorHelper_1.default.getFileLink(typeMirror), 3);
         this.addBlankLine();
-        this.addText((_b = (_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.description) !== null && _b !== void 0 ? _b : '');
+        if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines) {
+            const description = typeMirror.docComment.descriptionLines.reduce((previous, current) => previous + current + '\n', '');
+            this.addText(truncate_1.truncate(description, 300));
+        }
     }
     group(classes) {
         return classes.reduce((groups, currentClass) => {

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

@@ -1 +1 @@
-{"version":3,"file":"markdown-home-file.js","sourceRoot":"","sources":["../../src/model/markdown-home-file.ts"],"names":[],"mappings":";;;AACA,kGAAyF;AACzF,mDAA+C;AAE/C,MAAa,gBAAiB,SAAQ,4BAAY;IAChD,YAAmB,QAAgB,EAAS,KAAa,EAAE,aAAsB;QAC/E,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QADH,aAAQ,GAAR,QAAQ,CAAQ;QAAS,UAAK,GAAL,KAAK,CAAQ;QAEvD,IAAI,aAAa,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SAC7B;QACD,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACzB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAEO,cAAc,CAAC,KAAa;QAClC,MAAM,cAAc,GAAwB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9D,cAAc,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,GAAW,EAAE,EAAE;YACpD,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACtB,KAAK,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBAC3B,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,UAAgB;;QACnC,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,QAAQ,CAAC,oCAAwB,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACnE,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,OAAO,aAAC,UAAU,CAAC,UAAU,0CAAE,WAAW,mCAAI,EAAE,CAAC,CAAC;IACzD,CAAC;IAEO,KAAK,CAAC,OAAe;QAC3B,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE;YAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YAC7C,MAAM,KAAK,GAAW,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YAC5C,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAChB,CAAC;IAEO,aAAa,CAAC,UAAgB;;QACpC,OAAO,mBACL,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,2CAAG,IAAI,mCAAI,eAAe,CAC9G,CAAC;IACJ,CAAC;CACF;AA1CD,4CA0CC"}
+{"version":3,"file":"markdown-home-file.js","sourceRoot":"","sources":["../../src/model/markdown-home-file.ts"],"names":[],"mappings":";;;AACA,kGAAyF;AACzF,mDAA+C;AAC/C,+CAA4C;AAE5C,MAAa,gBAAiB,SAAQ,4BAAY;IAChD,YAAmB,QAAgB,EAAS,KAAa,EAAE,aAAsB;QAC/E,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QADH,aAAQ,GAAR,QAAQ,CAAQ;QAAS,UAAK,GAAL,KAAK,CAAQ;QAEvD,IAAI,aAAa,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SAC7B;QACD,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACzB,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAEO,cAAc,CAAC,KAAa;QAClC,MAAM,cAAc,GAAwB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9D,cAAc,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,GAAW,EAAE,EAAE;YACpD,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACtB,KAAK,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBAC3B,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,UAAgB;;QACnC,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,QAAQ,CAAC,oCAAwB,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACnE,IAAI,CAAC,YAAY,EAAE,CAAC;QAEpB,UAAI,UAAU,CAAC,UAAU,0CAAE,gBAAgB,EAAE;YAC3C,MAAM,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAC/D,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,QAAQ,GAAG,OAAO,GAAG,IAAI,EAChD,EAAE,CACH,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,mBAAQ,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC;SAC1C;IACH,CAAC;IAEO,KAAK,CAAC,OAAe;QAC3B,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE;YAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YAC7C,MAAM,KAAK,GAAW,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YAC5C,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAChB,CAAC;IAEO,aAAa,CAAC,UAAgB;;QACpC,OAAO,mBACL,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,2CAAG,IAAI,mCAAI,eAAe,CAC9G,CAAC;IACJ,CAAC;CACF;AAjDD,4CAiDC"}

package/lib/settings.d.ts

@@ -8,6 +8,7 @@ export interface SettingsConfig {
     targetGenerator: GeneratorChoices;
     indexOnly: boolean;
     defaultGroupName: string;
+    sanitizeHtml: boolean;
 }
 export declare class Settings {
     config: SettingsConfig;
@@ -22,5 +23,7 @@ export declare class Settings {
     private static typeTranspilerCache?;
     get typeTranspiler(): ProcessorTypeTranspiler;
     get indexOnly(): boolean;
+    get sanitizeHtml(): boolean;
+    get numberOfVisibleDescriptionLinesOnHomePage(): number;
     getDefaultGroupName(): string;
 }

package/lib/settings.js

@@ -50,6 +50,12 @@ class Settings {
     get indexOnly() {
         return this.config.indexOnly;
     }
+    get sanitizeHtml() {
+        return this.config.sanitizeHtml;
+    }
+    get numberOfVisibleDescriptionLinesOnHomePage() {
+        return 5;
+    }
     getDefaultGroupName() {
         return this.config.defaultGroupName;
     }

package/lib/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AACA,4FAAwF;AACxF,iGAAwF;AACxF,kGAAsG;AActG,MAAa,QAAQ;IAGnB,YAA2B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;IAAG,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,MAAsB;QACxC,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAGD,IAAI,cAAc;QAChB,IAAI,QAAQ,CAAC,mBAAmB,EAAE;YAChC,OAAO,QAAQ,CAAC,mBAAmB,CAAC;SACrC;QACD,QAAQ,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE;YACnC,KAAK,QAAQ;gBACX,QAAQ,CAAC,mBAAmB,GAAG,IAAI,0CAAmB,EAAE,CAAC;gBACzD,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC,KAAK,SAAS;gBACZ,QAAQ,CAAC,mBAAmB,GAAG,IAAI,gCAAoB,EAAE,CAAC;gBAC1D,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC,KAAK,gBAAgB;gBACnB,QAAQ,CAAC,mBAAmB,GAAG,IAAI,gDAA0B,EAAE,CAAC;gBAChE,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC;gBACE,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC3C;IACH,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;CACF;AA3DD,4BA2DC"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AACA,4FAAwF;AACxF,iGAAwF;AACxF,kGAAsG;AAetG,MAAa,QAAQ;IAGnB,YAA2B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;IAAG,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,MAAsB;QACxC,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAID,IAAI,cAAc;QAChB,IAAI,QAAQ,CAAC,mBAAmB,EAAE;YAChC,OAAO,QAAQ,CAAC,mBAAmB,CAAC;SACrC;QACD,QAAQ,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE;YACnC,KAAK,QAAQ;gBACX,QAAQ,CAAC,mBAAmB,GAAG,IAAI,0CAAmB,EAAE,CAAC;gBACzD,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC,KAAK,SAAS;gBACZ,QAAQ,CAAC,mBAAmB,GAAG,IAAI,gCAAoB,EAAE,CAAC;gBAC1D,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC,KAAK,gBAAgB;gBACnB,QAAQ,CAAC,mBAAmB,GAAG,IAAI,gDAA0B,EAAE,CAAC;gBAChE,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC;gBACE,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC3C;IACH,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IAClC,CAAC;IAED,IAAI,yCAAyC;QAC3C,OAAO,CAAC,CAAC;IACX,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;CACF;AApED,4BAoEC"}

package/lib/util/truncate.d.ts

@@ -0,0 +1 @@
+export declare function truncate(str: string, n: number): string;

package/lib/util/truncate.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.truncate = void 0;
+function truncate(str, n) {
+    return str.length > n ? str.substr(0, n - 1) + '…' : str;
+}
+exports.truncate = truncate;
+//# sourceMappingURL=truncate.js.map

package/lib/util/truncate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"truncate.js","sourceRoot":"","sources":["../../src/util/truncate.ts"],"names":[],"mappings":";;;AAAA,SAAgB,QAAQ,CAAC,GAAW,EAAE,CAAS;IAC7C,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC;AAClE,CAAC;AAFD,4BAEC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.5.1",
+  "version": "2.6.0-beta.1",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",

package/src/cli/generate.ts

@@ -49,6 +49,15 @@ const argv = yargs.options({
     default: 'Miscellaneous',
     describe: 'Defines the @group name to be used when a file does not specify it.',
   },
+  sanitizeHtml: {
+    type: 'boolean',
+    default: true,
+    describe:
+      'When on, any special character within your ApexDocs is converted into its HTML code representation. ' +
+      'This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" ' +
+      'because otherwise the content within < and > would be treated as HTML tags and not shown in the output. ' +
+      'Content in @example blocks are never sanitized.',
+  },
 }).argv;
 
 Settings.build({
@@ -59,6 +68,7 @@ Settings.build({
   targetGenerator: argv.targetGenerator as GeneratorChoices,
   indexOnly: argv.indexOnly,
   defaultGroupName: argv.defaultGroupName,
+  sanitizeHtml: argv.sanitizeHtml,
 });
 
 Apexdocs.generate();

package/src/model/file.ts

@@ -1,7 +1,8 @@
 import xss = require('xss');
+import { Settings } from '../settings';
 
 const xssFilter = new xss.FilterXSS({
-  whiteList: { br: [], p: [], ul: [], li: [] },
+  whiteList: { br: [], p: [], ul: [], li: [], code: [], pre: [] },
 });
 
 export abstract class File {
@@ -16,7 +17,8 @@ export abstract class File {
   }
 
   addText(text: string, encodeHtml = true) {
-    const textToAdd = encodeHtml ? xssFilter.process(text) : text;
+    const shouldEncode = encodeHtml && Settings.getInstance().sanitizeHtml;
+    const textToAdd = shouldEncode ? xssFilter.process(text) : text;
     this._contents += textToAdd;
     this.addBlankLine();
   }

package/src/model/markdown-file.ts

@@ -21,18 +21,19 @@ export class MarkdownFile extends File {
   public addText(text: string, encodeHtml = true) {
     text = MarkdownFile.replaceInlineLinks(text);
     text = MarkdownFile.replaceInlineEmails(text);
+
     super.addText(text, encodeHtml);
   }
 
   startCodeBlock() {
-    this._contents += '```';
+    this.addText('```');
     const sourceLanguage = 'apex';
     this._contents += sourceLanguage;
     this.addBlankLine();
   }
 
   endCodeBlock() {
-    this._contents += '```';
+    this.addText('```');
     this.addBlankLine();
   }
 

package/src/model/markdown-generation-util/type-declaration-util.ts

@@ -8,9 +8,11 @@ export function declareType(markdownFile: MarkdownFile, typeMirror: Type): void
     markdownFile.addText(`\`${currentAnnotation.type.toUpperCase()}\``);
   });
 
-  if (typeMirror.docComment?.description) {
+  if (typeMirror.docComment?.descriptionLines) {
     markdownFile.addBlankLine();
-    markdownFile.addText(typeMirror.docComment.description);
+    for (const currentLine of typeMirror.docComment.descriptionLines) {
+      markdownFile.addText(currentLine);
+    }
     markdownFile.addBlankLine();
   }
 

package/src/model/markdown-home-file.ts

@@ -1,6 +1,7 @@
 import { Type } from '@cparra/apex-reflection';
 import ClassFileGeneratorHelper from '../transpiler/markdown/class-file-generatorHelper';
 import { MarkdownFile } from './markdown-file';
+import { truncate } from '../util/truncate';
 
 export class MarkdownHomeFile extends MarkdownFile {
   constructor(public fileName: string, public types: Type[], headerContent?: string) {
@@ -26,7 +27,14 @@ export class MarkdownHomeFile extends MarkdownFile {
     this.addBlankLine();
     this.addTitle(ClassFileGeneratorHelper.getFileLink(typeMirror), 3);
     this.addBlankLine();
-    this.addText(typeMirror.docComment?.description ?? '');
+
+    if (typeMirror.docComment?.descriptionLines) {
+      const description = typeMirror.docComment.descriptionLines.reduce(
+        (previous, current) => previous + current + '\n',
+        '',
+      );
+      this.addText(truncate(description, 300));
+    }
   }
 
   private group(classes: Type[]): Map<string, Type[]> {

package/src/settings.ts

@@ -13,6 +13,7 @@ export interface SettingsConfig {
   targetGenerator: GeneratorChoices;
   indexOnly: boolean;
   defaultGroupName: string;
+  sanitizeHtml: boolean;
 }
 
 export class Settings {
@@ -48,6 +49,7 @@ export class Settings {
   }
 
   private static typeTranspilerCache?: ProcessorTypeTranspiler;
+
   get typeTranspiler(): ProcessorTypeTranspiler {
     if (Settings.typeTranspilerCache) {
       return Settings.typeTranspilerCache;
@@ -71,6 +73,14 @@ export class Settings {
     return this.config.indexOnly;
   }
 
+  get sanitizeHtml(): boolean {
+    return this.config.sanitizeHtml;
+  }
+
+  get numberOfVisibleDescriptionLinesOnHomePage() {
+    return 5;
+  }
+
   public getDefaultGroupName(): string {
     return this.config.defaultGroupName;
   }

package/src/util/truncate.ts

@@ -0,0 +1,3 @@
+export function truncate(str: string, n: number) {
+  return str.length > n ? str.substr(0, n - 1) + '…' : str;
+}