@cparra/apexdocs 1.13.8 → 1.16.0

package/.gitattributes

@@ -0,0 +1,2 @@
+# Set the default line return behavior, in case people don't have core.autocrlf set.
+* text=auto

package/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: Tests
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Cache node modules
+        uses: actions/cache@v2
+        env:
+          cache-name: cache-node-modules
+        with:
+          # npm cache files are stored in `~/.npm` on Linux/macOS
+          path: ~/.npm
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+            ${{ runner.os }}-build-
+            ${{ runner.os }}-
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Test
+        run: npm test

package/README.md

@@ -1,4 +1,5 @@
 # ApexDocs
+# ApexDocs
 
 <p align="center">
   <b>ApexDocs is a Node.js library with CLI capabilities to generate documentation for Salesforce Apex classes.</b>
@@ -8,14 +9,21 @@
 
 ## Description
 
-ApexDocs was built as an alternative to the [Java based ApexDoc tool](https://github.com/SalesforceFoundation/ApexDoc) originally created by Aslam Bari and later maintained by Salesforce.org, as that tool is no longer being maintained.
+ApexDocs was built as an alternative to the [Java based ApexDoc tool](https://github.com/SalesforceFoundation/ApexDoc)
+originally created by Aslam Bari and later maintained by Salesforce.org, as that tool is no longer being maintained.
 
-ApexDocs is a Node.js library built on Typescript and hosted on [npm](https://www.npmjs.com/package/@cparra/apexdocs). It offers CLI capabilities to automatically generate a set of files that fully document each one of you classes. Additionally it can be imported and consumed directly by your JavaScript code.
+ApexDocs is a Node.js library built on Typescript and hosted on [npm](https://www.npmjs.com/package/@cparra/apexdocs).
+It offers CLI capabilities to automatically generate a set of files that fully document each one of you classes.
+Additionally, it can be imported and consumed directly by your JavaScript code.
 
 There are some key differences between ApexDocs and the Java based ApexDoc tool:
 
-- **Recursive file search through your module directory structure**. In an `sfdx` based project, all of your classes will be documented by specifying the top-most directory where file search should begin.
-- **Unopinionated documentation site generation**. Instead of creating HTML files, ApexDocs generates a Markdown (.md) file per Apex class being documented. This means you can host your files in static web hosting services that parse Markdown like Github Pages or Netlify, and use site generators like Jekyll or Gatsby. This gives you the freedom to decide how to style your site to match your needs.
+- **Recursive file search through your module directory structure**. In an `sfdx` based project, all of your classes
+  will be documented by specifying the top-most directory where file search should begin.
+- **Unopinionated documentation site generation**. Instead of creating HTML files, ApexDocs generates a Markdown (.md)
+  file per Apex class being documented. This means you can host your files in static web hosting services that parse
+  Markdown like Github Pages or Netlify, and use site generators like Jekyll or Gatsby. This gives you the freedom to
+  decide how to style your site to match your needs.
 
 ### Demo
 
@@ -58,19 +66,22 @@ 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       |
-| --configPath      | -c    | The path to the JSON configuration file that defines the structure of the documents to generate.                 | N/A                                 | No       |
-| --group           | -o    | Define whether the generated files should be grouped by the @group tag on the top level classes.                 | `true`                              | No       |
+| Parameter         | Alias | Description                                                                                                                                 | Default                             | Required |
+| ----------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------| ----------------------------------- | -------- |
+| --sourceDir       | -s    | The directory or directories location(s) which contains your apex .cls classes. Multiple directories can be specified separated by spaces   | 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       |
+| --configPath      | -c    | The path to the JSON configuration file that defines the structure of the documents to generate.                                            | N/A                                 | No       |
+| --group           | -o    | Define whether the generated files should be grouped by the @group tag on the top level classes.                                            | `true`                              | No       |
+| --indexOnly       | N/A   | Defines whether only the index file should be  generated.                                                        | `false`                             | 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.
+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:
 
@@ -80,7 +91,8 @@ _Note_: Everything in the configuration file is optional. When something is not
 
 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.
+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`
 
@@ -92,9 +104,11 @@ Defines the `@group` name to be used when a file does not specify it.
 
 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.
+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.
+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)
 
@@ -104,7 +118,8 @@ Gives you control over the home page.
 
 Default: None
 
-Allows you to embedd custom content into your home page by using the `header` property to point to the a file which contents will be added to the top of the generated home page.
+Allows you to embed custom content into your home page by using the `header` property to point to the a 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.
 
@@ -128,7 +143,9 @@ Whether the `@date` tag should be used to add the file's date to the page.
 
 Default: 1
 
-The starting H tag level for the document. Each title will use this as the starting point to generate the approaprite `<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.
+The starting H tag level for the document. Each title will use this as the starting point to generate 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.
 
 ```
 {
@@ -150,7 +167,8 @@ The starting H tag level for the document. Each title will use this as the start
 
 If you are just interested in the documentation parsing capabilities, you can import ApexDocs into your own project.
 
-Use the `generate` function to create a list of `ClassModel` that includes all of the parsed information from your .cls files.
+Use the `generate` function to create a list of `ClassModel` that includes all the parsed information from your .cls
+files.
 
 `generate(sourceDirectory[,recursive][,scope][,outputDir])`
 
@@ -167,19 +185,20 @@ let documentedClasses = generate('src', true, ['global'], 'docs');
 
 ## 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 span through
+multiple lines, ending with `*/`.
 
 ### Documenting Classes
 
 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.                                                                                                   |
-| `@author`      | The author of the class. Note that this only gets added if it is explicitly defined through the configuration class that it should.        |
-| `@date`        | The date the class was created. Note that this only gets added if it is explicitly defined through the configuration class that it should. |
+| 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.                                                                                                                                          |
+| `@author`      | The author of the class. Note that this only gets added if it is explicitly defined through the configuration class that it should. Multiple authors can be added per class.      |
+| `@date`        | The date the class was created. Note that this only gets added if it is explicitly defined through the configuration class that it should. Multiple dates can be added per class. |
 
 **Example**
 
@@ -187,7 +206,10 @@ The following tags are supported on the class level:
 /**
  * @description This is my class description.
  */
- public with sharing class TestClass { }
+public with sharing
+
+class TestClass {
+}
 ```
 
 ### Documenting Enums
@@ -204,7 +226,7 @@ The following tags are supported on the enum level:
 /**
  * @description This is my enum description.
  */
- public Enum ExampleEnum { VALUE_1, VALUE_2 }
+public Enum ExampleEnum{VALUE_1,VALUE_2}
 ```
 
 ### Documenting Properties
@@ -221,7 +243,7 @@ The following tags are supported on the property level:
 /**
  * @description This is my property description.
  */
- public String ExampleProperty { get; set; }
+public String ExampleProperty{get;set;}
 ```
 
 ### Documenting Methods and Constructors
@@ -248,13 +270,13 @@ 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){
 ```
 
 ### Inline linking
 
-Apexdocs allows you to reference other classes from anywhere in your docs, and automatically creates a link to that class
-file for easy navigation.
+Apexdocs allows you to reference other classes from anywhere in your docs, and automatically creates a link to that
+class file for easy navigation.
 
 Apexdocs recognizes 2 different syntax when linking files:
 
@@ -269,7 +291,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){
 ```
 
 ## Typescript

package/docs/404.html

@@ -1,24 +1,24 @@
----
-layout: default
----
-
-<style type="text/css" media="screen">
-  .container {
-    margin: 10px auto;
-    max-width: 600px;
-    text-align: center;
-  }
-  h1 {
-    margin: 30px 0;
-    font-size: 4em;
-    line-height: 1;
-    letter-spacing: -1px;
-  }
-</style>
-
-<div class="container">
-  <h1>404</h1>
-
-  <p><strong>Page not found :(</strong></p>
-  <p>The requested page could not be found.</p>
-</div>
+---
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

package/docs/README.md

@@ -1,9 +1,49 @@
-# Classes
-## Sample Classes
-
-### [SampleClass](/Sample-Classes/SampleClass.md)
-
-
-This is a class description.
-
-
+# Welcome to the Apex Docs documentation example.
+
+This content will be added to the top of the home page.
+
+# Classes
+## Sample Classes
+
+### [SampleClass](/Sample-Classes/SampleClass.md)
+
+
+This is a class description.
+
+
+
+### [SampleClass](/Sample-Classes/SampleClass.md)
+
+
+This is a class description.
+
+
+
+### [SampleClass2](/Sample-Classes/SampleClass2.md)
+
+
+This is a class description.
+
+
+
+### [SampleClassMultipleAuthorsAndDates](/Sample-Classes/SampleClassMultipleAuthorsAndDates.md)
+
+
+This is a class description.
+
+
+## Sample Interfaces
+
+### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+
+
+This is an interface description.
+
+
+
+### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+
+
+This is an interface description.
+
+

package/docs/Sample-Classes/SampleClass.md

@@ -1,6 +1,3 @@
----
-layout: default
----
 # SampleClass class
 
 `NamespaceAccessible`
@@ -9,10 +6,10 @@ This is a class description.
 
 ## Related
 
-[SampleInterface](../Sample-Interfaces/SampleInterface.md)
+[SampleInterface](/Sample-Interfaces/SampleInterface.md)
 
 
-[SampleClass2](../Sample-Classes/SampleClass2.md)
+[SampleClass2](/Sample-Classes/SampleClass2.md)
 
 ---
 ## Constructors

package/docs/Sample-Classes/SampleClass2.md

@@ -1,6 +1,3 @@
----
-layout: default
----
 # SampleClass2 class
 
 `NamespaceAccessible`
@@ -9,10 +6,10 @@ This is a class description.
 
 ## Related
 
-[SampleInterface](../Sample-Interfaces/SampleInterface.md)
+[SampleInterface](/Sample-Interfaces/SampleInterface.md)
 
 
-[SampleClass](../Sample-Classes/SampleClass.md)
+[SampleClass](/Sample-Classes/SampleClass.md)
 
 ---
 ## Constructors

package/docs/Sample-Classes/SampleClassMultipleAuthorsAndDates.md

@@ -0,0 +1,120 @@
+# SampleClassMultipleAuthorsAndDates class
+
+`NamespaceAccessible`
+
+This is a class description.
+
+
+**Author:** John Doe
+
+**Author:** Jane Doe
+
+**Date:** 1/1/2021
+
+**Date:** 2/2/2022
+## Related
+
+[SampleInterface](/Sample-Interfaces/SampleInterface.md)
+
+
+[SampleClass2](/Sample-Classes/SampleClass2.md)
+
+---
+## Constructors
+### `SampleClassMultipleAuthorsAndDates()`
+
+`NamespaceAccessible`
+
+Constructs a SampleClassMultipleAuthorsAndDates without any arguments.
+#### Example
+```
+<pre>
+SampleClassMultipleAuthorsAndDates sampleInstance = new SampleClassMultipleAuthorsAndDates();
+```
+
+### `SampleClassMultipleAuthorsAndDates(String argument)`
+
+`NamespaceAccessible`
+
+Constructs a SampleClassMultipleAuthorsAndDates with an argument.
+#### Parameters
+
+| Param | Description |
+| ----- | ----------- |
+|`argument` |  Some argument |
+
+---
+## Properties
+
+### `AnotherProp` → `Decimal`
+
+`NamespaceAccessible`
+
+This is a Decimal property.
+
+### `MyProp` → `String`
+
+`NamespaceAccessible`
+
+This is a String property.
+
+---
+## Methods
+### `call()` → `void`
+
+`NamespaceAccessible`
+
+Calls the method. This methods allows you to call it.
+
+### `testMethod(String argument)` → `String`
+
+`NamespaceAccessible`
+
+Executes commands based on the passed in argument.
+
+#### Example
+```
+<pre>
+String result = SampleClassMultipleAuthorsAndDates.testMethod();
+System.debug(result);
+```
+
+---
+## Inner Classes
+
+### SampleClassMultipleAuthorsAndDates.AnotherInnerClass class
+
+Inner class belonging to SampleClassMultipleAuthorsAndDates.
+
+---
+#### Properties
+
+##### `InnerProp` → `public`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()` → `void`
+
+Executes from the inner class.
+
+---
+### SampleClassMultipleAuthorsAndDates.InnerClass class
+
+Inner class belonging to SampleClassMultipleAuthorsAndDates.
+
+---
+#### Properties
+
+##### `InnerProp` → `public`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()` → `void`
+
+Executes from the inner class.
+
+---

package/docs/Sample-Interfaces/SampleInterface.md

@@ -1,13 +1,10 @@
----
-layout: default
----
 # SampleInterface interface
 
 This is an interface description.
 
 ## Related
 
-[SampleClass](../Sample-Classes/SampleClass.md)
+[SampleClass](/Sample-Classes/SampleClass.md)
 
 ---
 ## Methods

package/docs/_config.yml

@@ -1,40 +1,40 @@
-# Welcome to Jekyll!
-#
-# This config file is meant for settings that affect your whole blog, values
-# which you are expected to set up once and rarely edit after that. If you find
-# yourself editing this file very often, consider using Jekyll's data files
-# feature for the data you need to update frequently.
-#
-# For technical reasons, this file is *NOT* reloaded automatically when you use
-# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
-
-# Site settings
-# These are used to personalize your new site. If you look in the HTML files,
-# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
-# You can create any custom variable you would like, and they will be accessible
-# in the templates via {{ site.myvariable }}.
-title: API Reference
-email: your-email@example.com
-description: >- # this means to ignore newlines until "baseurl:"
-  This is a sample API documentation site, generated for Github Pages using ApexDocs
-baseurl: '/apexdocs' # the subpath of your site, e.g. /blog
-url: '' # the base hostname & protocol for your site, e.g. http://example.com
-twitter_username: jekyllrb
-github_username: jekyll
-
-# Build settings
-markdown: kramdown
-theme: jekyll-theme-cayman
-plugins:
-  - jekyll-feed
-# Exclude from processing.
-# The following items will not be processed, by default. Create a custom list
-# to override the default setting.
-# exclude:
-#   - Gemfile
-#   - Gemfile.lock
-#   - node_modules
-#   - vendor/bundle/
-#   - vendor/cache/
-#   - vendor/gems/
-#   - vendor/ruby/
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+title: API Reference
+email: your-email@example.com
+description: >- # this means to ignore newlines until "baseurl:"
+  This is a sample API documentation site, generated for Github Pages using ApexDocs
+baseurl: '/apexdocs' # the subpath of your site, e.g. /blog
+url: '' # the base hostname & protocol for your site, e.g. http://example.com
+twitter_username: jekyllrb
+github_username: jekyll
+
+# Build settings
+markdown: kramdown
+theme: jekyll-theme-cayman
+plugins:
+  - jekyll-feed
+# Exclude from processing.
+# The following items will not be processed, by default. Create a custom list
+# to override the default setting.
+# exclude:
+#   - Gemfile
+#   - Gemfile.lock
+#   - node_modules
+#   - vendor/bundle/
+#   - vendor/cache/
+#   - vendor/gems/
+#   - vendor/ruby/