@cparra/apexdocs 2.3.0 → 2.4.0

package/README.md

@@ -68,6 +68,11 @@ 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.
@@ -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,117 +114,33 @@ 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)
+| 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       |
+| --defaultGroupName | N/A   | Defines the `@group` name to be used when a file does not specify it.                                                    | `Miscellaneous`                     | No       |
 
-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)
-
-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`
+**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                                                                                                                                |
 |----------------|--------------------------------------------------------------------------------------------------------------------------------------------|
@@ -300,7 +221,8 @@ The following tags are supported on the method level:
  * @example
  * Object result = SampleClass.call('exampleAction');
  */
-public static Object call(String action) {}
+public static Object call(String action) {
+}
 ```
 
 ### Grouping Declarations Within A Class
@@ -310,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';
@@ -320,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
 
@@ -349,7 +275,7 @@ 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) {
 ```
 
 ---
@@ -358,10 +284,13 @@ 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 styling long text.
-  - Allowed tags are: `br`, `p`, `ul`, and `li`
+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>
@@ -371,9 +300,15 @@ Example
  *     <li>This is another list item</li>
  * </ul>
  */
-class MyClass {}
+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/README.md

@@ -11,7 +11,7 @@ Uses a block style apex doc
 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

package/lib/cli/generate.js

@@ -42,6 +42,11 @@ const argv = yargs.options({
         default: false,
         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({
     sourceDirectory: argv.sourceDir,
@@ -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,CAAC;QAC9B,QAAQ,EACN,mHAAmH;KACtH;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,2DAA2D;KACtE;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/settings.d.ts

@@ -7,6 +7,7 @@ export interface SettingsConfig {
     outputDir: string;
     targetGenerator: GeneratorChoices;
     indexOnly: boolean;
+    defaultGroupName: string;
 }
 export declare class Settings {
     config: SettingsConfig;
@@ -20,4 +21,5 @@ export declare class Settings {
     get outputDir(): string;
     get typeTranspiler(): ProcessorTypeTranspiler;
     get indexOnly(): boolean;
+    getDefaultGroupName(): string;
 }

package/lib/settings.js

@@ -41,6 +41,9 @@ class Settings {
     get indexOnly() {
         return this.config.indexOnly;
     }
+    getDefaultGroupName() {
+        return this.config.defaultGroupName;
+    }
 }
 exports.Settings = Settings;
 //# sourceMappingURL=settings.js.map

package/lib/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AACA,4FAAwF;AACxF,iGAAwF;AAaxF,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;IAED,IAAI,cAAc;QAChB,QAAQ,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE;YACnC,KAAK,QAAQ;gBACX,OAAO,IAAI,0CAAmB,EAAE,CAAC;YACnC,KAAK,SAAS;gBACZ,OAAO,IAAI,gCAAoB,EAAE,CAAC;YACpC;gBACE,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC3C;IACH,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;CACF;AA9CD,4BA8CC"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AACA,4FAAwF;AACxF,iGAAwF;AAcxF,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;IAED,IAAI,cAAc;QAChB,QAAQ,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE;YACnC,KAAK,QAAQ;gBACX,OAAO,IAAI,0CAAmB,EAAE,CAAC;YACnC,KAAK,SAAS;gBACZ,OAAO,IAAI,gCAAoB,EAAE,CAAC;YACpC;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;AAlDD,4BAkDC"}

package/lib/transpiler/markdown/class-file-generatorHelper.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const types_repository_1 = require("../../model/types-repository");
+const settings_1 = require("../../settings");
 class ClassFileGeneratorHelper {
     static getSanitizedGroup(classModel) {
         return this.getClassGroup(classModel).replace(/ /g, '-').replace('.', '');
@@ -19,7 +20,7 @@ class ClassFileGeneratorHelper {
     static getClassGroup(classModel) {
         var _a, _b;
         const groupAnnotation = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'group');
-        return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : 'Misc';
+        return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : settings_1.Settings.getInstance().getDefaultGroupName();
     }
 }
 exports.default = ClassFileGeneratorHelper;

package/lib/transpiler/markdown/class-file-generatorHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;AACA,mEAA+D;AAE/D,MAAqB,wBAAwB;IACpC,MAAM,CAAC,iBAAiB,CAAC,UAAgB;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAgB;QACxC,OAAO,IAAI,UAAU,CAAC,IAAI,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,IAAI,MAAM,CAAC;IAC9F,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAI,EAAE;YACT,qFAAqF;YACrF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;SACrC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,SAAG,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;QAC7G,aAAO,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,MAAM,CAAC;IACzC,CAAC;CACF;AAvBD,2CAuBC"}
+{"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;AACA,mEAA+D;AAC/D,6CAA0C;AAE1C,MAAqB,wBAAwB;IACpC,MAAM,CAAC,iBAAiB,CAAC,UAAgB;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAgB;QACxC,OAAO,IAAI,UAAU,CAAC,IAAI,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,IAAI,MAAM,CAAC;IAC9F,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAI,EAAE;YACT,qFAAqF;YACrF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;SACrC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,SAAG,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;QAC7G,aAAO,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAvBD,2CAuBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -24,7 +24,7 @@
     "postversion": "git push && git push --tags",
     "docs:init": "docsify init docs",
     "docs:serve": "docsify serve docs",
-    "execute:example": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify",
+    "execute:example": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify --defaultGroupName API",
     "execute:example:index:only": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify --indexOnly"
   },
   "author": "Cesar Parra",

package/src/cli/generate.ts

@@ -44,6 +44,11 @@ const argv = yargs.options({
     default: false,
     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.build({
@@ -53,6 +58,7 @@ Settings.build({
   outputDir: argv.targetDir,
   targetGenerator: argv.targetGenerator as GeneratorChoices,
   indexOnly: argv.indexOnly,
+  defaultGroupName: argv.defaultGroupName,
 });
 
 Apexdocs.generate();

package/src/settings.ts

@@ -11,6 +11,7 @@ export interface SettingsConfig {
   outputDir: string;
   targetGenerator: GeneratorChoices;
   indexOnly: boolean;
+  defaultGroupName: string;
 }
 
 export class Settings {
@@ -59,4 +60,8 @@ export class Settings {
   get indexOnly(): boolean {
     return this.config.indexOnly;
   }
+
+  public getDefaultGroupName(): string {
+    return this.config.defaultGroupName;
+  }
 }

package/src/transpiler/markdown/class-file-generatorHelper.ts

@@ -1,5 +1,6 @@
 import { Type } from '@cparra/apex-reflection';
 import { TypesRepository } from '../../model/types-repository';
+import { Settings } from '../../settings';
 
 export default class ClassFileGeneratorHelper {
   public static getSanitizedGroup(classModel: Type) {
@@ -22,6 +23,6 @@ export default class ClassFileGeneratorHelper {
 
   private static getClassGroup(classModel: Type): string {
     const groupAnnotation = classModel.docComment?.annotations.find((annotation) => annotation.name === 'group');
-    return groupAnnotation?.body ?? 'Misc';
+    return groupAnnotation?.body ?? Settings.getInstance().getDefaultGroupName();
   }
 }

package/docs/Misc/SampleClass.md

@@ -1,168 +0,0 @@
-# SampleClass
-
-`NAMESPACEACCESSIBLE`
-
-`APIVERSION: 54`
-
-`STATUS: ACTIVE`
-
-Something
-
-## Constructors
-### My Super Group
-##### `SampleClass()`
-
-`NAMESPACEACCESSIBLE`
-
-Constructs a SampleClass without any arguments. This relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-###### Throws
-|Exception|Description|
-|---|---|
-|`ExcName`|some exception|
-
-
-**CustomAnnotation** A Custom method annotation
-
-
-**See** [SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-###### Example
-```apex
-// Example
-SampleClass sampleInstance = new SampleClass();
-```
-
----
-### Other
-##### `SampleClass(String argument1, String argument2)`
-
-Constructs a SampleClass with an argument.
-
-###### Parameters
-|Param|Description|
-|---|---|
-|`argument1`|Argument1 definition|
-|`argument2`|Argument2 definition|
-
----
-## Fields
-### Common Constants
-
-* `ANOTHER_CONSTANT` → `String` 
-* `A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ]  - This is a constant.
----
-### Other variables
-
-* `someVariable` → `String` 
----
-## Properties
-
-### `AnotherProp` → `Decimal`
-
-`AURAENABLED` 
-
-This is a Decimal property.
-
-### `MyProp` → `String`
-
-`AURAENABLED` 
-`DEPRECATED` 
-
-This is a String property.
-
----
-## Methods
-### `static sampleMethod(String argument1, String argument2)`
-
-`NAMESPACEACCESSIBLE`
-
-Executes commands based on the passed in argument.
-
-#### Parameters
-|Param|Description|
-|---|---|
-|`argument1`|Argument1 to debug|
-|`argument2`|Argument2 to debug|
-
-#### Return
-
-**Type**
-
-String
-
-**Description**
-
-Empty string
-
-#### Example
-```apex
-String result = SampleClass.testMethod();
-System.debug(result);
-```
-
-### `static anotherSampleMethod(String arg1)`
-
-Something here
-
-#### Parameters
-|Param|Description|
-|---|---|
-
-
-**Arg1** The arg1 description
-
-### `static call()`
-
-Calls the method. This methods allows you to call it.
-
----
-## Enums
-### InnerEnum
-
-`NAMESPACEACCESSIBLE`
-
-This is a namespace accessible enum
-
-
----
-## Classes
-### AnotherInnerClass
-
-Inner class belonging to SampleClass.
-
-#### Properties
-
-##### `InnerProp` → `String`
-
-
-Description of the inner property.
-
----
-#### Methods
-##### `innerMethod()`
-
-Executes from the inner class.
-
----
-
-### InnerClass
-
-Inner class belonging to SampleClass.
-
-#### Properties
-
-##### `InnerProp` → `String`
-
-
-Description of the inner property.
-
----
-#### Methods
-##### `innerMethod()`
-
-Executes from the inner class.
-
----
-
----