@cparra/apexdocs 2.2.1 → 2.2.4

package/.github/workflows/close_stale.yml

@@ -0,0 +1,22 @@
+name: Close inactive issues
+on:
+  schedule:
+    - cron: "30 1 * * *"
+
+jobs:
+  close-issues:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v4
+        with:
+          days-before-issue-stale: -1
+          days-before-issue-close: 30
+          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."
+          days-before-pr-stale: -1
+          days-before-pr-close: -1
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

package/README.md

@@ -207,23 +207,8 @@ the `Properties` title will be `<h2>`, each property name will be an `<h3>`, etc
 
 ### Importing to your project
 
-If you are just interested in the documentation parsing capabilities, you can import ApexDocs into your own project.
-
-Use the `docGenerator` function to create a list of `ClassModel` that includes all the parsed information from your .cls
-files.
-
-`docGenerator(sourceDirectory[,recursive][,scope][,outputDir])`
-
-- `sourceDirectory` \<string>
-- `recursive` \<boolean>
-- `scope` \<string[]>
-- `outpurDir` \<string>
-
-```javascript
-var { docGenerator } = require('@cparra/apexdocs');
-
-let documentedClasses = docGenerator('src', true, ['global'], 'docs');
-```
+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
 
@@ -235,7 +220,7 @@ multiple lines, ending with `*/`.
 The following tags are supported on the class level:
 
 | Tag            | Description                                                                                                                                |
-| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+|----------------|--------------------------------------------------------------------------------------------------------------------------------------------|
 | `@description` | One or more lines describing the class.                                                                                                    |
 | `@see`         | The name of a related class.                                                                                                               |
 | `@group`       | The group to which the class belongs to.                                                                                                   |
@@ -257,7 +242,7 @@ public with sharing class TestClass {
 The following tags are supported on the enum level:
 
 | Tag            | Description                            |
-| -------------- | -------------------------------------- |
+|----------------|----------------------------------------|
 | `@description` | One or more lines describing the enum. |
 
 **Example**
@@ -276,7 +261,7 @@ public Enum ExampleEnum {
 The following tags are supported on the property level:
 
 | Tag            | Description                                |
-| -------------- | ------------------------------------------ |
+|----------------|--------------------------------------------|
 | `@description` | One or more lines describing the property. |
 
 **Example**
@@ -295,7 +280,7 @@ 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.    |

package/docs/README.md

@@ -1,4 +1,9 @@
 # Classes
+## Utils
+
+### [GroupedClass](/Utils/GroupedClass.md)
+
+Uses a block style apex doc
 ## Sample Classes
 
 ### [SampleClass](/Sample-Classes/SampleClass.md)

package/docs/Sample-Classes/SampleClass.md

@@ -113,6 +113,11 @@ String result = SampleClass.testMethod();
 System.debug(result);
 ```
 
+### `static anotherSampleMethod(String arg1)`
+#### Parameters
+|Param|Description|
+|---|---|
+
 ### `static call()`
 
 Calls the method. This methods allows you to call it.

package/docs/Sample-Interfaces/SampleInterface.md

@@ -1,3 +1,6 @@
+---
+layout: default
+---
 # SampleInterface
 
 This is an interface description.

package/docs/Some-group/GroupedClass.md

@@ -0,0 +1,7 @@
+# GroupedClass
+
+Some desc
+
+
+**Group** Some group
+

package/docs/Utils/GroupedClass.md

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

package/docs/index.md

@@ -0,0 +1,9 @@
+---
+layout: default
+---
+# Classes
+## Sample Interfaces
+
+### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+
+This is an interface description.

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

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

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

@@ -72,6 +72,15 @@ public with sharing class SampleClass {
         return '';
     }
 
+    /**
+     * @description Something here
+     * @arg1
+     */
+    public static String anotherSampleMethod(String arg1) {
+        System.debug('something');
+        return '';
+    }
+
 
     /**
      * @description Calls the method.

package/lib/application/Apexdocs.js

@@ -11,6 +11,7 @@ const settings_1 = require("../settings");
 const transpiler_1 = require("../transpiler/transpiler");
 const file_writer_1 = require("../service/file-writer");
 const types_repository_1 = require("../model/types-repository");
+const error_logger_1 = require("../util/error-logger");
 /**
  * Application entry-point to generate documentation out of Apex source files.
  */
@@ -30,6 +31,8 @@ class Apexdocs {
         file_writer_1.FileWriter.write(generatedFiles, (fileName) => {
             logger_1.Logger.log(`${fileName} processed.`);
         });
+        // Error logging
+        error_logger_1.default.logErrors(filteredTypes);
     }
 }
 exports.Apexdocs = Apexdocs;

package/lib/application/Apexdocs.js.map

@@ -1 +1 @@
-{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAuC;AACvC,yDAAkD;AAClD,wDAAoD;AACpD,gEAA4D;AAE5D;;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;IACL,CAAC;;AAlBH,4BA2BC;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;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"}

package/lib/model/markdown-generation-util/doc-comment-annotation-util.js

@@ -9,15 +9,20 @@ function addCustomDocCommentAnnotations(markdownFile, docCommentAware) {
         markdownFile.addText(buildDocAnnotationText(currentAnnotation));
         markdownFile.addBlankLine();
     });
-    function capitalizeFirstLetter(text) {
-        return text.charAt(0).toUpperCase() + text.slice(1);
+    function splitAndCapitalize(text) {
+        const words = text.split(/[-_]+/);
+        const capitalizedWords = [];
+        for (const word of words) {
+            capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
+        }
+        return capitalizedWords.join(' ');
     }
     function buildDocAnnotationText(annotation) {
         let annotationBodyText = annotation.body;
         if (annotation.name.toLowerCase() === 'see') {
             annotationBodyText = class_file_generatorHelper_1.default.getFileLinkByTypeName(annotation.body);
         }
-        return `**${capitalizeFirstLetter(annotation.name)}** ${annotationBodyText}`;
+        return `**${splitAndCapitalize(annotation.name)}** ${annotationBodyText}`;
     }
 }
 exports.addCustomDocCommentAnnotations = addCustomDocCommentAnnotations;

package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map

@@ -1 +1 @@
-{"version":3,"file":"doc-comment-annotation-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/doc-comment-annotation-util.ts"],"names":[],"mappings":";;;AACA,qGAA4F;AAO5F,SAAgB,8BAA8B,CAAC,YAA0B,EAAE,eAAgC;;IACzG,MAAA,eAAe,CAAC,UAAU,0CAAE,WAAW,CACpC,MAAM,CAAC,CAAC,iBAAuC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,aAAa,EAC5F,OAAO,CAAC,CAAC,iBAAuC,EAAE,EAAE;QACnD,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QAChE,YAAY,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC,EAAE;IAEL,SAAS,qBAAqB,CAAC,IAAY;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC;IAED,SAAS,sBAAsB,CAAC,UAAgC;QAC9D,IAAI,kBAAkB,GAAG,UAAU,CAAC,IAAI,CAAC;QACzC,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,EAAE;YAC3C,kBAAkB,GAAG,oCAAwB,CAAC,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SACtF;QACD,OAAO,KAAK,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,kBAAkB,EAAE,CAAC;IAC/E,CAAC;AACH,CAAC;AApBD,wEAoBC"}
+{"version":3,"file":"doc-comment-annotation-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/doc-comment-annotation-util.ts"],"names":[],"mappings":";;;AACA,qGAA4F;AAO5F,SAAgB,8BAA8B,CAAC,YAA0B,EAAE,eAAgC;;IACzG,MAAA,eAAe,CAAC,UAAU,0CAAE,WAAW,CACpC,MAAM,CAAC,CAAC,iBAAuC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,aAAa,EAC5F,OAAO,CAAC,CAAC,iBAAuC,EAAE,EAAE;QACnD,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QAChE,YAAY,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC,EAAE;IAEL,SAAS,kBAAkB,CAAC,IAAY;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAClC,MAAM,gBAAgB,GAAG,EAAE,CAAC;QAC5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SACrE;QACD,OAAO,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,SAAS,sBAAsB,CAAC,UAAgC;QAC9D,IAAI,kBAAkB,GAAG,UAAU,CAAC,IAAI,CAAC;QACzC,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,EAAE;YAC3C,kBAAkB,GAAG,oCAAwB,CAAC,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SACtF;QACD,OAAO,KAAK,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,kBAAkB,EAAE,CAAC;IAC5E,CAAC;AACH,CAAC;AAzBD,wEAyBC"}

package/lib/util/error-logger.d.ts

@@ -0,0 +1,8 @@
+import { Type } from '@cparra/apex-reflection';
+export default class ErrorLogger {
+    static logErrors(types: Type[]): void;
+    private static logErrorsForSingleType;
+    private static logTypeErrors;
+    private static logErrorsForClass;
+    private static logErrorsForInterface;
+}

package/lib/util/error-logger.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ErrorLogger {
+    static logErrors(types) {
+        types.forEach((currentType) => {
+            this.logErrorsForSingleType(currentType);
+        });
+    }
+    static logErrorsForSingleType(currentType, parentType) {
+        this.logTypeErrors(currentType);
+        if (currentType.type_name === 'class') {
+            this.logErrorsForClass(currentType);
+        }
+        else if (currentType.type_name === 'interface') {
+            this.logErrorsForInterface(currentType);
+        }
+    }
+    static logTypeErrors(currentType, parentType) {
+        var _a;
+        if ((_a = currentType.docComment) === null || _a === void 0 ? void 0 : _a.error) {
+            const typeName = parentType ? `${parentType.name}.${currentType.name}` : currentType.name;
+            console.log(`${typeName} - Doc comment parsing error. Level: Type`);
+            console.log(`Comment:\n ${currentType.docComment.rawDeclaration}`);
+            console.log(currentType.docComment.error);
+            console.log('=================================');
+        }
+    }
+    static logErrorsForClass(classMirror, parentType) {
+        const typeName = parentType ? `${parentType.name}.${classMirror.name}` : classMirror.name;
+        classMirror.constructors.forEach((currentConstructor) => {
+            var _a;
+            if ((_a = currentConstructor.docComment) === null || _a === void 0 ? void 0 : _a.error) {
+                console.log(`${typeName} - Doc comment parsing error. Level: Constructor`);
+                console.log(`Comment:\n ${currentConstructor.docComment.rawDeclaration}`);
+                console.log(currentConstructor.docComment.error);
+                console.log('=================================');
+            }
+        });
+        classMirror.fields.forEach((currentField) => {
+            var _a;
+            if ((_a = currentField.docComment) === null || _a === void 0 ? void 0 : _a.error) {
+                console.log(`${typeName} - Doc comment parsing error. Level: Field`);
+                console.log(`Comment:\n ${currentField.docComment.rawDeclaration}`);
+                console.log(currentField.docComment.error);
+                console.log('=================================');
+            }
+        });
+        classMirror.properties.forEach((currentProperty) => {
+            var _a;
+            if ((_a = currentProperty.docComment) === null || _a === void 0 ? void 0 : _a.error) {
+                console.log(`${typeName} - Doc comment parsing error. Level: Property`);
+                console.log(`Comment:\n ${currentProperty.docComment.rawDeclaration}`);
+                console.log(currentProperty.docComment.error);
+                console.log('=================================');
+            }
+        });
+        classMirror.methods.forEach((currentMethod) => {
+            var _a;
+            if ((_a = currentMethod.docComment) === null || _a === void 0 ? void 0 : _a.error) {
+                console.log(`${typeName} - Doc comment parsing error. Level: Method`);
+                console.log(`Comment:\n ${currentMethod.docComment.rawDeclaration}`);
+                console.log(currentMethod.docComment.error);
+                console.log('=================================');
+            }
+        });
+        classMirror.enums.forEach((currentEnum) => {
+            this.logErrorsForSingleType(currentEnum, classMirror);
+        });
+        classMirror.interfaces.forEach((currentInterface) => {
+            this.logErrorsForSingleType(currentInterface, classMirror);
+        });
+        classMirror.classes.forEach((currentClass) => {
+            this.logErrorsForSingleType(currentClass, classMirror);
+        });
+    }
+    static logErrorsForInterface(interfaceMirror) {
+        interfaceMirror.methods.forEach((currentMethod) => {
+            var _a;
+            if ((_a = currentMethod.docComment) === null || _a === void 0 ? void 0 : _a.error) {
+                console.log(`${interfaceMirror.name} - Doc comment parsing error. Level: Method`);
+                console.log(`Comment: ${currentMethod.docComment.rawDeclaration}`);
+                console.log(currentMethod.docComment.error);
+                console.log('=================================');
+            }
+        });
+    }
+}
+exports.default = ErrorLogger;
+//# sourceMappingURL=error-logger.js.map

package/lib/util/error-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-logger.js","sourceRoot":"","sources":["../../src/util/error-logger.ts"],"names":[],"mappings":";;AAEA,MAAqB,WAAW;IACvB,MAAM,CAAC,SAAS,CAAC,KAAa;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YAC5B,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,WAAiB,EAAE,UAAiB;QACxE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QAEhC,IAAI,WAAW,CAAC,SAAS,KAAK,OAAO,EAAE;YACrC,IAAI,CAAC,iBAAiB,CAAC,WAA0B,CAAC,CAAC;SACpD;aAAM,IAAI,WAAW,CAAC,SAAS,KAAK,WAAW,EAAE;YAChD,IAAI,CAAC,qBAAqB,CAAC,WAA8B,CAAC,CAAC;SAC5D;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,WAAiB,EAAE,UAAiB;;QAC/D,UAAI,WAAW,CAAC,UAAU,0CAAE,KAAK,EAAE;YACjC,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAW,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;YAC3F,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,2CAA2C,CAAC,CAAC;YACpE,OAAO,CAAC,GAAG,CAAC,cAAc,WAAW,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;YACnE,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAC1C,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;SAClD;IACH,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,WAAwB,EAAE,UAAiB;QAC1E,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAW,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;QAC3F,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,kBAAkB,EAAE,EAAE;;YACtD,UAAI,kBAAkB,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACxC,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,kDAAkD,CAAC,CAAC;gBAC3E,OAAO,CAAC,GAAG,CAAC,cAAc,kBAAkB,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBAC1E,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBACjD,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;aAClD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;;YAC1C,UAAI,YAAY,CAAC,UAAU,0CAAE,KAAK,EAAE;gBAClC,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,4CAA4C,CAAC,CAAC;gBACrE,OAAO,CAAC,GAAG,CAAC,cAAc,YAAY,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACpE,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC3C,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;aAClD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;;YACjD,UAAI,eAAe,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACrC,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,+CAA+C,CAAC,CAAC;gBACxE,OAAO,CAAC,GAAG,CAAC,cAAc,eAAe,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACvE,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC9C,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;aAClD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;YAC5C,UAAI,aAAa,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACnC,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,6CAA6C,CAAC,CAAC;gBACtE,OAAO,CAAC,GAAG,CAAC,cAAc,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACrE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC5C,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;aAClD;QACH,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YACxC,IAAI,CAAC,sBAAsB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE;YAClD,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YAC3C,IAAI,CAAC,sBAAsB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,eAAgC;QACnE,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;YAChD,UAAI,aAAa,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACnC,OAAO,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,IAAI,6CAA6C,CAAC,CAAC;gBAClF,OAAO,CAAC,GAAG,CAAC,YAAY,aAAa,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC;gBACnE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC5C,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;aAClD;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxFD,8BAwFC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.2.1",
+  "version": "2.2.4",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -64,7 +64,7 @@
     ]
   },
   "dependencies": {
-    "@cparra/apex-reflection": "^1.2.0",
+    "@cparra/apex-reflection": "^1.5.0",
     "fast-xml-parser": "^4.0.1",
     "chalk": "^4.1.2",
     "html-entities": "^2.3.2",

package/src/application/Apexdocs.ts

@@ -1,6 +1,6 @@
 import { ApexFileReader } from '../service/apex-file-reader';
 import { DefaultFileSystem } from '../service/file-system';
-import { ReflectionResult, reflect, Type } from '@cparra/apex-reflection';
+import { ReflectionResult, reflect, Type, ClassMirror } from '@cparra/apex-reflection';
 import { Logger } from '../util/logger';
 import { createManifest } from '../service/manifest-factory';
 import { RawBodyParser } from '../service/parser';
@@ -8,6 +8,7 @@ import { Settings } from '../settings';
 import Transpiler from '../transpiler/transpiler';
 import { FileWriter } from '../service/file-writer';
 import { TypesRepository } from '../model/types-repository';
+import ErrorLogger from '../util/error-logger';
 
 /**
  * Application entry-point to generate documentation out of Apex source files.
@@ -30,6 +31,9 @@ export class Apexdocs {
     FileWriter.write(generatedFiles, (fileName: string) => {
       Logger.log(`${fileName} processed.`);
     });
+
+    // Error logging
+    ErrorLogger.logErrors(filteredTypes);
   }
 
   static _reflectionWithLogger = (declarationBody: string): ReflectionResult => {

package/src/model/markdown-generation-util/doc-comment-annotation-util.ts

@@ -15,8 +15,13 @@ export function addCustomDocCommentAnnotations(markdownFile: MarkdownFile, docCo
       markdownFile.addBlankLine();
     });
 
-  function capitalizeFirstLetter(text: string) {
-    return text.charAt(0).toUpperCase() + text.slice(1);
+  function splitAndCapitalize(text: string) {
+    const words = text.split(/[-_]+/);
+    const capitalizedWords = [];
+    for (const word of words) {
+      capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
+    }
+    return capitalizedWords.join(' ');
   }
 
   function buildDocAnnotationText(annotation: DocCommentAnnotation) {
@@ -24,6 +29,6 @@ export function addCustomDocCommentAnnotations(markdownFile: MarkdownFile, docCo
     if (annotation.name.toLowerCase() === 'see') {
       annotationBodyText = ClassFileGeneratorHelper.getFileLinkByTypeName(annotation.body);
     }
-    return `**${capitalizeFirstLetter(annotation.name)}** ${annotationBodyText}`;
+    return `**${splitAndCapitalize(annotation.name)}** ${annotationBodyText}`;
   }
 }

package/src/util/error-logger.ts

@@ -0,0 +1,91 @@
+import { ClassMirror, InterfaceMirror, Type } from '@cparra/apex-reflection';
+
+export default class ErrorLogger {
+  public static logErrors(types: Type[]): void {
+    types.forEach((currentType) => {
+      this.logErrorsForSingleType(currentType);
+    });
+  }
+
+  private static logErrorsForSingleType(currentType: Type, parentType?: Type): void {
+    this.logTypeErrors(currentType);
+
+    if (currentType.type_name === 'class') {
+      this.logErrorsForClass(currentType as ClassMirror);
+    } else if (currentType.type_name === 'interface') {
+      this.logErrorsForInterface(currentType as InterfaceMirror);
+    }
+  }
+
+  private static logTypeErrors(currentType: Type, parentType?: Type) {
+    if (currentType.docComment?.error) {
+      const typeName = parentType ? `${parentType!.name}.${currentType.name}` : currentType.name;
+      console.log(`${typeName} - Doc comment parsing error. Level: Type`);
+      console.log(`Comment:\n ${currentType.docComment.rawDeclaration}`);
+      console.log(currentType.docComment.error);
+      console.log('=================================');
+    }
+  }
+
+  private static logErrorsForClass(classMirror: ClassMirror, parentType?: Type): void {
+    const typeName = parentType ? `${parentType!.name}.${classMirror.name}` : classMirror.name;
+    classMirror.constructors.forEach((currentConstructor) => {
+      if (currentConstructor.docComment?.error) {
+        console.log(`${typeName} - Doc comment parsing error. Level: Constructor`);
+        console.log(`Comment:\n ${currentConstructor.docComment.rawDeclaration}`);
+        console.log(currentConstructor.docComment.error);
+        console.log('=================================');
+      }
+    });
+
+    classMirror.fields.forEach((currentField) => {
+      if (currentField.docComment?.error) {
+        console.log(`${typeName} - Doc comment parsing error. Level: Field`);
+        console.log(`Comment:\n ${currentField.docComment.rawDeclaration}`);
+        console.log(currentField.docComment.error);
+        console.log('=================================');
+      }
+    });
+
+    classMirror.properties.forEach((currentProperty) => {
+      if (currentProperty.docComment?.error) {
+        console.log(`${typeName} - Doc comment parsing error. Level: Property`);
+        console.log(`Comment:\n ${currentProperty.docComment.rawDeclaration}`);
+        console.log(currentProperty.docComment.error);
+        console.log('=================================');
+      }
+    });
+
+    classMirror.methods.forEach((currentMethod) => {
+      if (currentMethod.docComment?.error) {
+        console.log(`${typeName} - Doc comment parsing error. Level: Method`);
+        console.log(`Comment:\n ${currentMethod.docComment.rawDeclaration}`);
+        console.log(currentMethod.docComment.error);
+        console.log('=================================');
+      }
+    });
+
+    classMirror.enums.forEach((currentEnum) => {
+      this.logErrorsForSingleType(currentEnum, classMirror);
+    });
+
+    classMirror.interfaces.forEach((currentInterface) => {
+      this.logErrorsForSingleType(currentInterface, classMirror);
+    });
+
+    classMirror.classes.forEach((currentClass) => {
+      this.logErrorsForSingleType(currentClass, classMirror);
+    });
+  }
+
+  private static logErrorsForInterface(interfaceMirror: InterfaceMirror): void {
+    interfaceMirror.methods.forEach((currentMethod) => {
+      if (currentMethod.docComment?.error) {
+        console.log(`${interfaceMirror.name} - Doc comment parsing error. Level: Method`);
+        console.log(`Comment: ${currentMethod.docComment.rawDeclaration}`);
+        console.log(currentMethod.docComment.error);
+        console.log('=================================');
+      }
+    });
+  }
+}