@cparra/apexdocs 2.2.5 → 2.5.0-beta.0

package/.github/workflows/close_stale.yml

@@ -10,10 +10,10 @@ jobs:
       issues: write
       pull-requests: write
     steps:
-      - uses: actions/stale@v4
+      - uses: actions/stale@v5
         with:
-          days-before-issue-stale: -1
-          days-before-issue-close: 30
+          days-before-issue-stale: 30
+          days-before-issue-close: 14
           stale-issue-label: "stale"
           stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
           close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale."

package/README.md

@@ -68,9 +68,14 @@ public class MyClass {
 }
 ```
 
+* Apex docs blocks can now all be in a single line
+* Support for grouping blocks of related code within a class
+* Support for HTML tags
+* And more!
+
 ### Demo
 
-ApexDocs currently supports generating markdown files for Jekyll and Docsify sites.
+ApexDocs currently supports generating markdown files for Jekyll and Docsify sites, as well as generating plain markdown files.
 
 ### In the wild
 
@@ -81,13 +86,13 @@ ApexDocs currently supports generating markdown files for Jekyll and Docsify sit
 
 Demo
 
-- [Docsify](https://cesarparra.github.io/apexdocs-docsify-example/)
+- [Docsify](https://cesarparra.github.io/apexdocs/)
 
 ### [Jekyll](https://jekyllrb.com/)
 
 Demo
 
-- [Jekyll](https://cesarparra.github.io/apexdocs/)
+- [Jekyll](https://cesarparra.github.io/apexdocs-docsify-example/)
 
 ## Installation
 
@@ -109,116 +114,34 @@ 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 namespaceaccessible public` | No       |
-| --targetGenerator | -g    | Define the static file generator for which the documents will be created. Currently supports jekyll and docsify.         | `jekyll`                            | No       |
-| --indexOnly       | N/A   | Defines whether only the index file should be  generated.                                                                | `false`                             | No       |
-| --configPath      | -c    | (Only versions 1.X) The path to the JSON configuration file that defines the structure of the documents to docGenerator. | N/A                                 | No       |
-| --group           | -o    | (Only versions 1.X) Define whether the generated files should be grouped by the @group tag on the top level classes.     | `true`                              | No       |
-
-#### Configuration File
-
-You can optionally specify the path to a configuration JSON file through the `--configPath` parameter. This let's you
-have some additional control over the content outputs.
-
-The configuration file allows you to specify the following:
-
-_Note_: Everything in the configuration file is optional. When something is not specified, the default will be used.
-
-`root` (String)
-
-Default: None
-
-Allows you to specify the root directory for where the files are being generated. This can be helpful when embedding the
-generated docs into an existing site so that the links are generated correctly.
-
-`defaultGroupName`
-
-Default: Miscellaneous
-
-Defines the `@group` name to be used when a file does not specify it.
-
-`sourceLanguage`
-
-Default: None
-
-Defines the name of the language that will be used when generating `@example` blocks. Use this when you are interested
-in using syntax highlighting for your project.
-
-Even though the source code material for which documentation is generated is always `Apex`, generally you will be able
-to use a syntax highlighter that recognizes `java` source code, so set this value to `java` in those cases.
-
-`home` (Object)
-
-Gives you control over the home page.
-
-`home.header` (String)
-
-Default: None
-
-Allows you to embed custom content into your home page by using the `header` property to point to the file which
-contents will be added to the top of the generated home page.
-
-Specify the path with the content that you want to embed.
-
-`content` (Object)
-
-Gives you control over the content pages.
-
-`content.includeAuthor` (Boolean)
-
-Default: false
-
-Whether the `@author` tag should be used to add the file's author to the page.
-
-`content.includeDate` (Boolean)
+| 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 and docsify. | `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       |
 
-Default: false
-
-Whether the `@date` tag should be used to add the file's date to the page.
-
-`content.startingHeadingLevel` (Number)
-
-Default: 1
-
-The starting H tag level for the document. Each title will use this as the starting point to docGenerator the
-appropriate `<h#>` tag. For example, if set to 1, the class' file name at the top of the file will use an `<h1>` tag,
-the `Properties` title will be `<h2>`, each property name will be an `<h3>`, etc.
-
-```
-{
-  "root": "root-directory",
-  "defaultGrouName": "api",
-  "sourceLanguage": "java",
-  "home": {
-    "header": "./examples/includes/header.md"
-  },
-  "content": {
-    "startingHeadingLevel": 1,
-    "includeAuthor": true,
-    "includeDate": true
-  }
-}
-```
 
 ### Importing to your project
 
-If you are just interested in the Apex parsing capabilities, you can use the standalone [Apex Reflection Library](https://www.npmjs.com/package/@cparra/apex-reflection)
+If you are just interested in the Apex parsing capabilities, you can use the
+standalone [Apex Reflection Library](https://www.npmjs.com/package/@cparra/apex-reflection)
 which is what gets used by this library behind the scenes to generate the documentation files.
 
 ## Documentation Format
 
-ApexDocs picks up blocks of comments throughout your `.cls` files. The block must begin with `/**` and span through
-multiple lines, ending with `*/`.
+ApexDocs picks up blocks of comments throughout your `.cls` files. The block must begin with `/**` and end with `*/`.
 
 ### Documenting Classes
 
 The following tags are supported on the class level:
 
+**Note** Any custom generated tag is also supported. Custom tags can be added with at symbol (`@`) followed by the name
+of the tag. For example `@custom-tag`
+
 | Tag            | Description                                                                                                                                |
 |----------------|--------------------------------------------------------------------------------------------------------------------------------------------|
 | `@description` | One or more lines describing the class.                                                                                                    |
@@ -279,13 +202,14 @@ Methods and constructors support the same tags.
 
 The following tags are supported on the method level:
 
-| Tag                       | Description                                       |
-|---------------------------|---------------------------------------------------|
-| `@description`            | One or more lines describing the method.          |
-| `@param` _paramName_      | Description of a single parameter.                |
-| `@return`                 | Description of the return value of the method.    |
-| `@example`                | Example of how the code can be used or called.    |
-| `@throws` _ExceptionName_ | Description of an exception thrown by the method. |
+| Tag                          | Description                                       |
+|------------------------------|---------------------------------------------------|
+| `@description`               | One or more lines describing the method.          |
+| `@param` _paramName_         | Description of a single parameter.                |
+| `@return`                    | Description of the return value of the method.    |
+| `@example`                   | Example of how the code can be used or called.    |
+| `@throws` _ExceptionName_    | Description of an exception thrown by the method. |
+| `@exception` _ExceptionName_ | Same as `@throws`. V2 only                        |
 
 **Example**
 
@@ -298,6 +222,7 @@ The following tags are supported on the method level:
  * Object result = SampleClass.call('exampleAction');
  */
 public static Object call(String action) {
+}
 ```
 
 ### Grouping Declarations Within A Class
@@ -307,6 +232,7 @@ groups of constants that should be grouped together because they share a common
 of constants representing the possible values for different picklists.)
 
 You can group things together within a class by using the following syntax:
+
 ```apex
 // @start-group Group Name or Description
 public static final String CONSTANT_FOO = 'Foo';
@@ -317,16 +243,19 @@ public static final String CONSTANT_BAR = 'Bar';
 Groups of members are displayed together under their own subsection after its name or description.
 
 Some notes about grouping:
+
 * This is only supported on classes, NOT enums and interfaces
 * Supports
-  * Properties
-  * Fields (variables and constants)
-  * Constructors
-  * Methods
-* BUT only members of the same type are grouped together. For example, 
-if you have a group that contains properties and methods the properties will be grouped together under Properties -> Group Name, and the methods will be grouped together under Methods -> Group Name
+    * Properties
+    * Fields (variables and constants)
+    * Constructors
+    * Methods
+* BUT only members of the same type are grouped together. For example,
+  if you have a group that contains properties and methods the properties will be grouped together under Properties ->
+  Group Name, and the methods will be grouped together under Methods -> Group Name
 * Does not support inner types (inner classes, interfaces, and enums)
-* It is necessary to use `// @end-group` whenever a group has been started, otherwise a parsing error will be raised for that file.
+* It is necessary to use `// @end-group` whenever a group has been started, otherwise a parsing error will be raised for
+  that file.
 
 ### Inline linking
 
@@ -346,9 +275,40 @@ Apexdocs recognizes 2 different syntax when linking files:
  * @param param1 An <<ExampleClass>> instance. Can also do {@link ExampleClass}
  * @return The result of the operation.
  */
-public static Object class(ExampleClass param1) {
+public static Object class (ExampleClass param1) {
+```
+
+---
+
+Email addresses can also be inlined linked by using the `{@email EMAIL_ADDRESS}` syntax.
+
+### HTML support
+
+For the most part all HTML is sanitized. 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`
+
+Example
+
+```apex
+/**
+ * @description <p>This is a paragraph</p>
+ * <p>And this is another paragraph</p>
+ * <ul>
+ *     <li>This is a list item</li>
+ *     <li>This is another list item</li>
+ * </ul>
+ */
+class MyClass {
+}
 ```
 
 ## Typescript
 
 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/GroupedClass.md

@@ -0,0 +1,10 @@
+# GroupedClass
+
+Uses a block style apex doc
+
+
+**Group** Main
+
+
+**Test Class** [SampleClass](/Main/SampleClass.md)
+

package/docs/{Sample-Classes → Main}/SampleClass.md

@@ -6,10 +6,10 @@
 
 `STATUS: ACTIVE`
 
-This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)              But this 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** Sample Classes
+**Group** Main
 
 
 **CustomAnnotation** A Custom annotation
@@ -29,6 +29,7 @@ This is a class description. This class relates to [SampleInterface](/Sample-Int
 Constructs a SampleClass without any arguments. This relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)
 
 ###### Throws
+
 |Exception|Description|
 |---|---|
 |`ExcName`|some exception|
@@ -52,6 +53,7 @@ SampleClass sampleInstance = new SampleClass();
 Constructs a SampleClass with an argument.
 
 ###### Parameters
+
 |Param|Description|
 |---|---|
 |`argument1`|Argument1 definition|
@@ -92,6 +94,7 @@ This is a String property.
 Executes commands based on the passed in argument.
 
 #### Parameters
+
 |Param|Description|
 |---|---|
 |`argument1`|Argument1 to debug|
@@ -118,6 +121,7 @@ System.debug(result);
 Something here
 
 #### Parameters
+
 |Param|Description|
 |---|---|
 

package/docs/README.md

@@ -1,17 +1,16 @@
 # Classes
-## Utils
+## Main
 
-### [GroupedClass](/Utils/GroupedClass.md)
+### [GroupedClass](/Main/GroupedClass.md)
 
 Uses a block style apex doc
-## Sample Classes
 
-### [SampleClass](/Sample-Classes/SampleClass.md)
+### [SampleClass](/Main/SampleClass.md)
 
-This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)              But this 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](/Misc/SampleClassWithoutModifier.md)
+### [SampleClassWithoutModifier](/API/SampleClassWithoutModifier.md)
 
 
 ## Sample Interfaces
@@ -19,8 +18,3 @@ This is a class description. This class relates to [SampleInterface](/Sample-Int
 ### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
 
 This is an interface description.
-## Stripe Integration
-
-### [SampleTestClass](/Stripe-Integration/SampleTestClass.md)
-
-

package/docs/index.html

@@ -1,21 +1,22 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <title>Document</title>
-  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-  <meta name="description" content="Description">
-  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
-  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
-</head>
-<body>
-  <div id="app"></div>
-  <script>
-    window.$docsify = {
-      name: '',
-      repo: ''
-    }
-  </script>
-  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
-</body>
-</html>
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: '',
+      repo: ''
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+</body>
+</html>

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

@@ -1,6 +1,6 @@
 /**********************************************************
 Uses a block style apex doc
-@group           Utils
+@group           Main
 @test-class      {@link SampleClass}
 ***********************************************************/
 public class GroupedClass {

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

@@ -2,7 +2,7 @@
  * @description This is a class description. This class relates to {@link SampleInterface}
  *              But this {@link ClassThatDoesNotExist} does not exist.
  *              You can also link using this syntax <<SampleInterface>>
- * @group Sample Classes
+ * @group Main
  * @CustomAnnotation A Custom annotation
  * @author Cesar Parra
  * @see SampleInterface

package/lib/application/Apexdocs.d.ts

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

package/lib/application/Apexdocs.js

@@ -20,27 +20,30 @@ class Apexdocs {
      * Generates documentation out of Apex source files.
      */
     static generate() {
+        logger_1.Logger.log('Initializing...');
         const fileBodies = apex_file_reader_1.ApexFileReader.processFiles(new file_system_1.DefaultFileSystem());
         const manifest = manifest_factory_1.createManifest(new parser_1.RawBodyParser(fileBodies), this._reflectionWithLogger);
         const filteredTypes = manifest.filteredByAccessModifierAndAnnotations(settings_1.Settings.getInstance().scope);
         types_repository_1.TypesRepository.getInstance().populate(filteredTypes);
-        logger_1.Logger.log(`Parsed ${filteredTypes.length} files`);
+        logger_1.Logger.clear();
+        logger_1.Logger.logSingle(`Filtered ${manifest.types.length - filteredTypes.length} file(s) based on scope: ${settings_1.Settings.getInstance().scope}`, false, 'green', false);
+        logger_1.Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, 'green', false);
         const processor = settings_1.Settings.getInstance().typeTranspiler;
         transpiler_1.default.generate(filteredTypes, processor);
         const generatedFiles = processor.fileBuilder().files();
         file_writer_1.FileWriter.write(generatedFiles, (fileName) => {
-            logger_1.Logger.log(`${fileName} processed.`);
+            logger_1.Logger.logSingle(`${fileName} processed.`, false, 'green', false);
         });
         // Error logging
         error_logger_1.default.logErrors(filteredTypes);
     }
 }
 exports.Apexdocs = Apexdocs;
-Apexdocs._reflectionWithLogger = (declarationBody) => {
+Apexdocs._reflectionWithLogger = (apexBundle) => {
     var _a;
-    const result = apex_reflection_1.reflect(declarationBody);
+    const result = apex_reflection_1.reflect(apexBundle.rawTypeContent);
     if (result.error) {
-        logger_1.Logger.log(`Parsing error ${(_a = result.error) === null || _a === void 0 ? void 0 : _a.message}`);
+        logger_1.Logger.error(`${apexBundle.filePath} - Parsing error ${(_a = result.error) === null || _a === void 0 ? void 0 : _a.message}`);
     }
     return result;
 };

package/lib/application/Apexdocs.js.map

@@ -1 +1 @@
-{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAAuF;AACvF,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAuC;AACvC,yDAAkD;AAClD,wDAAoD;AACpD,gEAA4D;AAC5D,uDAA+C;AAE/C;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,iCAAc,CAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAE3F,MAAM,aAAa,GAAW,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;QAC5G,kCAAe,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAEtD,eAAM,CAAC,GAAG,CAAC,UAAU,aAAa,CAAC,MAAM,QAAQ,CAAC,CAAC;QACnD,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC;QACxD,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QACvD,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,QAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,aAAa,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,gBAAgB;QAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;;AArBH,4BA8BC;AAPQ,8BAAqB,GAAG,CAAC,eAAuB,EAAoB,EAAE;;IAC3E,MAAM,MAAM,GAAG,yBAAO,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,GAAG,CAAC,iBAAiB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACtD;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
+{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAAuF;AACvF,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAuC;AACvC,yDAAkD;AAClD,wDAAoD;AACpD,gEAA4D;AAC5D,uDAA+C;AAG/C;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,iCAAc,CAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAE3F,MAAM,aAAa,GAAW,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;QAC5G,kCAAe,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QACtD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CACd,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BACtD,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,EACF,KAAK,EACL,OAAO,EACP,KAAK,CACN,CAAC;QACF,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC;QACxD,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QACvD,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,QAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,SAAS,CAAC,GAAG,QAAQ,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,gBAAgB;QAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;;AA/BH,4BAwCC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,yBAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACjF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/lib/cli/generate.js

@@ -34,13 +34,18 @@ const argv = yargs.options({
         type: 'string',
         alias: 'g',
         default: 'jekyll',
-        choices: ['jekyll', 'docsify'],
-        describe: 'Define the static file generator for which the documents will be created. Currently supports jekyll, and docsify.',
+        choices: ['jekyll', 'docsify', 'plain-markdown'],
+        describe: 'Define the static file generator for which the documents will be created. Currently supports jekyll, docsify, and plain markdown.',
     },
     indexOnly: {
         type: 'boolean',
         default: false,
-        describe: 'Defines whether only the index file should be  generated.',
+        describe: 'Defines whether only the index file should be generated.',
+    },
+    defaultGroupName: {
+        type: 'string',
+        default: 'Miscellaneous',
+        describe: 'Defines the @group name to be used when a file does not specify it.',
     },
 }).argv;
 settings_1.Settings.build({
@@ -50,6 +55,7 @@ settings_1.Settings.build({
     outputDir: argv.targetDir,
     targetGenerator: argv.targetGenerator,
     indexOnly: argv.indexOnly,
+    defaultGroupName: argv.defaultGroupName,
 });
 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,CAAC;QAC9B,QAAQ,EACN,mHAAmH;KACtH;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,2DAA2D;KACtE;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;CAC1B,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;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"}

package/lib/model/apex-bundle.d.ts

@@ -1,5 +1,6 @@
 export default class ApexBundle {
+    filePath: string;
     rawTypeContent: string;
     rawMetadataContent: string | null;
-    constructor(rawTypeContent: string, rawMetadataContent: string | null);
+    constructor(filePath: string, rawTypeContent: string, rawMetadataContent: string | null);
 }

package/lib/model/apex-bundle.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 class ApexBundle {
-    constructor(rawTypeContent, rawMetadataContent) {
+    constructor(filePath, rawTypeContent, rawMetadataContent) {
+        this.filePath = filePath;
         this.rawTypeContent = rawTypeContent;
         this.rawMetadataContent = rawMetadataContent;
     }

package/lib/model/apex-bundle.js.map

@@ -1 +1 @@
-{"version":3,"file":"apex-bundle.js","sourceRoot":"","sources":["../../src/model/apex-bundle.ts"],"names":[],"mappings":";;AAAA,MAAqB,UAAU;IAC7B,YAAmB,cAAsB,EAAS,kBAAiC;QAAhE,mBAAc,GAAd,cAAc,CAAQ;QAAS,uBAAkB,GAAlB,kBAAkB,CAAe;IAAG,CAAC;CACxF;AAFD,6BAEC"}
+{"version":3,"file":"apex-bundle.js","sourceRoot":"","sources":["../../src/model/apex-bundle.ts"],"names":[],"mappings":";;AAAA,MAAqB,UAAU;IAC7B,YAAmB,QAAgB,EAAS,cAAsB,EAAS,kBAAiC;QAAzF,aAAQ,GAAR,QAAQ,CAAQ;QAAS,mBAAc,GAAd,cAAc,CAAQ;QAAS,uBAAkB,GAAlB,kBAAkB,CAAe;IAAG,CAAC;CACjH;AAFD,6BAEC"}

package/lib/model/file.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.File = void 0;
-const html_entities_1 = require("html-entities");
+const xss = require("xss");
+const xssFilter = new xss.FilterXSS({
+    whiteList: { br: [], p: [], ul: [], li: [] },
+});
 class File {
     constructor(fileName, dir) {
         this.fileName = fileName;
@@ -12,7 +15,7 @@ class File {
         return this._contents;
     }
     addText(text, encodeHtml = true) {
-        const textToAdd = encodeHtml ? html_entities_1.encode(text) : text;
+        const textToAdd = encodeHtml ? 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,iDAAuC;AAEvC,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,sBAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACnD,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;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"}

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

@@ -2,6 +2,7 @@ import { File } from './file';
 export declare class MarkdownFile extends File {
     fileExtension(): string;
     addTitle(text: string, level?: number): void;
+    addText(text: string, encodeHtml?: boolean): void;
     startCodeBlock(): void;
     endCodeBlock(): void;
     addHorizontalRule(): void;
@@ -9,4 +10,5 @@ export declare class MarkdownFile extends File {
     addTableRow(...columns: string[]): void;
     addListItem(text: string): void;
     protected static replaceInlineLinks(text: string): string;
+    protected static replaceInlineEmails(text: string): string;
 }

package/lib/model/markdown-file.js

@@ -17,6 +17,11 @@ class MarkdownFile extends file_1.File {
         this._contents += title;
         this.addBlankLine();
     }
+    addText(text, encodeHtml = true) {
+        text = MarkdownFile.replaceInlineLinks(text);
+        text = MarkdownFile.replaceInlineEmails(text);
+        super.addText(text, encodeHtml);
+    }
     startCodeBlock() {
         this._contents += '```';
         const sourceLanguage = 'apex';
@@ -32,6 +37,7 @@ class MarkdownFile extends file_1.File {
         this.addBlankLine();
     }
     initializeTable(...headers) {
+        this.addBlankLine();
         this._contents += '|';
         headers.forEach((header) => {
             this._contents += header + '|';
@@ -76,6 +82,23 @@ class MarkdownFile extends file_1.File {
         }
         return text;
     }
+    static replaceInlineEmails(text) {
+        // Parsing links using {@link ClassName} format
+        const linkFormatRegEx = '{@email (.*?)}';
+        const expression = new RegExp(linkFormatRegEx, 'gi');
+        let match;
+        const matches = [];
+        do {
+            match = expression.exec(text);
+            if (match) {
+                matches.push(match);
+            }
+        } while (match);
+        for (const currentMatch of matches) {
+            text = text.replace(currentMatch[0], `[${currentMatch[1]}](mailto:${currentMatch[1]})`);
+        }
+        return text;
+    }
 }
 exports.MarkdownFile = MarkdownFile;
 //# sourceMappingURL=markdown-file.js.map