@cparra/apexdocs 1.15.0 → 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

@@ -75,6 +75,8 @@ The CLI supports the following parameters:
 | --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
 

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,49 +1,49 @@
 # 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.
-
-
+
+# 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,112 +1,112 @@
-# SampleClass class
-
-`NamespaceAccessible`
-
-This is a class description.
-
-## Related
-
-[SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-
-[SampleClass2](/Sample-Classes/SampleClass2.md)
-
----
-## Constructors
-### `SampleClass()`
-
-`NamespaceAccessible`
-
-Constructs a SampleClass without any arguments.
-#### Example
-```
-<pre>
-SampleClass sampleInstance = new SampleClass();
-```
-
-### `SampleClass(String argument)`
-
-`NamespaceAccessible`
-
-Constructs a SampleClass 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 = SampleClass.testMethod();
-System.debug(result);
-```
-
----
-## Inner Classes
-
-### SampleClass.AnotherInnerClass class
-
-Inner class belonging to SampleClass.
-
----
-#### Properties
-
-##### `InnerProp` → `public`
-
-Description of the inner property.
-
----
-#### Methods
-##### `innerMethod()` → `void`
-
-Executes from the inner class.
-
----
-### SampleClass.InnerClass class
-
-Inner class belonging to SampleClass.
-
----
-#### Properties
-
-##### `InnerProp` → `public`
-
-Description of the inner property.
-
----
-#### Methods
-##### `innerMethod()` → `void`
-
-Executes from the inner class.
-
----
+# SampleClass class
+
+`NamespaceAccessible`
+
+This is a class description.
+
+## Related
+
+[SampleInterface](/Sample-Interfaces/SampleInterface.md)
+
+
+[SampleClass2](/Sample-Classes/SampleClass2.md)
+
+---
+## Constructors
+### `SampleClass()`
+
+`NamespaceAccessible`
+
+Constructs a SampleClass without any arguments.
+#### Example
+```
+<pre>
+SampleClass sampleInstance = new SampleClass();
+```
+
+### `SampleClass(String argument)`
+
+`NamespaceAccessible`
+
+Constructs a SampleClass 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 = SampleClass.testMethod();
+System.debug(result);
+```
+
+---
+## Inner Classes
+
+### SampleClass.AnotherInnerClass class
+
+Inner class belonging to SampleClass.
+
+---
+#### Properties
+
+##### `InnerProp` → `public`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()` → `void`
+
+Executes from the inner class.
+
+---
+### SampleClass.InnerClass class
+
+Inner class belonging to SampleClass.
+
+---
+#### Properties
+
+##### `InnerProp` → `public`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()` → `void`
+
+Executes from the inner class.
+
+---

package/docs/Sample-Classes/SampleClass2.md

@@ -1,112 +1,112 @@
-# SampleClass2 class
-
-`NamespaceAccessible`
-
-This is a class description.
-
-## Related
-
-[SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-
-[SampleClass](/Sample-Classes/SampleClass.md)
-
----
-## Constructors
-### `SampleClass2()`
-
-`NamespaceAccessible`
-
-Constructs a SampleClass2 without any arguments.
-#### Example
-```
-<pre>
-SampleClass2 sampleInstance = new SampleClass2();
-```
-
-### `SampleClass2(String argument)`
-
-`NamespaceAccessible`
-
-Constructs a SampleClass2 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 = SampleClass2.testMethod();
-System.debug(result);
-```
-
----
-## Inner Classes
-
-### SampleClass2.AnotherInnerClass class
-
-Inner class belonging to SampleClass2.
-
----
-#### Properties
-
-##### `InnerProp` → `public`
-
-Description of the inner property.
-
----
-#### Methods
-##### `innerMethod()` → `void`
-
-Executes from the inner class.
-
----
-### SampleClass2.InnerClass class
-
-Inner class belonging to SampleClass2.
-
----
-#### Properties
-
-##### `InnerProp` → `public`
-
-Description of the inner property.
-
----
-#### Methods
-##### `innerMethod()` → `void`
-
-Executes from the inner class.
-
----
+# SampleClass2 class
+
+`NamespaceAccessible`
+
+This is a class description.
+
+## Related
+
+[SampleInterface](/Sample-Interfaces/SampleInterface.md)
+
+
+[SampleClass](/Sample-Classes/SampleClass.md)
+
+---
+## Constructors
+### `SampleClass2()`
+
+`NamespaceAccessible`
+
+Constructs a SampleClass2 without any arguments.
+#### Example
+```
+<pre>
+SampleClass2 sampleInstance = new SampleClass2();
+```
+
+### `SampleClass2(String argument)`
+
+`NamespaceAccessible`
+
+Constructs a SampleClass2 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 = SampleClass2.testMethod();
+System.debug(result);
+```
+
+---
+## Inner Classes
+
+### SampleClass2.AnotherInnerClass class
+
+Inner class belonging to SampleClass2.
+
+---
+#### Properties
+
+##### `InnerProp` → `public`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()` → `void`
+
+Executes from the inner class.
+
+---
+### SampleClass2.InnerClass class
+
+Inner class belonging to SampleClass2.
+
+---
+#### Properties
+
+##### `InnerProp` → `public`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()` → `void`
+
+Executes from the inner class.
+
+---