@cparra/apexdocs 2.14.0 → 2.15.1

package/README.md

@@ -118,21 +118,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. Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource.                                                                                                                                   | `global`        | No       |
-| --targetGenerator  | -g    | Define the static file generator for which the documents will be created. Currently supports: `jekyll`, `docsify`, `plain-markdown`, and `openapi`.                                                                                                                                                                                                                         | `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       |
-| --sanitizeHtml     | N/A   | When on, any special character within your ApexDocs is converted into its HTML code representation. This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" because otherwise the content within < and > would be treated as HTML tags and not shown in the output. Content in @example blocks are never sanitized. | `Apex REST Api` | No       |
-| --openApiTitle     | N/A   | If using "openapi" as the target generator, this allows you to specify the OpenApi title value.                                                                                                                                                                                                                                                                             | true            | No       |
-| --title            | N/A   | Allows you to specify the home page main title. If using "openapi" this acts as an alias to the openApiTitle parameter                                                                                                                                                                                                                                                      | `Classes`       | No       |
-| --namespace        | N/A   | The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. If generating an OpenApi definition, it will be added to the file's Server Url.                                                                                                                                                                | N/A             | No       |
-| --openApiFileName  | N/A   | If using "openapi" as the target generator, this allows you to specify the name of the output file.                                                                                                                                                                                                                                                                         | `openapi`       | No       |
-| --includeMetadata  | N/A   | Whether to include the file's meta.xml information: Whether it is active and and the API version                                                                                                                                                                                                                                                                            | false           | No       |
+| 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. Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource.                                                                                                                                   | `global`        | No       |
+| --targetGenerator      | -g    | Define the static file generator for which the documents will be created. Currently supports: `jekyll`, `docsify`, `plain-markdown`, and `openapi`.                                                                                                                                                                                                                         | `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       |
+| --sanitizeHtml         | N/A   | When on, any special character within your ApexDocs is converted into its HTML code representation. This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" because otherwise the content within < and > would be treated as HTML tags and not shown in the output. Content in @example blocks are never sanitized. | `Apex REST Api` | No       |
+| --openApiTitle         | N/A   | If using "openapi" as the target generator, this allows you to specify the OpenApi title value.                                                                                                                                                                                                                                                                             | true            | No       |
+| --title                | N/A   | Allows you to specify the home page main title. If using "openapi" this acts as an alias to the openApiTitle parameter                                                                                                                                                                                                                                                      | `Classes`       | No       |
+| --namespace            | N/A   | The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. If generating an OpenApi definition, it will be added to the file's Server Url.                                                                                                                                                                | N/A             | No       |
+| --openApiFileName      | N/A   | If using "openapi" as the target generator, this allows you to specify the name of the output file.                                                                                                                                                                                                                                                                         | `openapi`       | No       |
+| --includeMetadata      | N/A   | Whether to include the file's meta.xml information: Whether it is active and and the API version                                                                                                                                                                                                                                                                            | false           | No       |
+| --documentationRootDir | N/A   | The root directory where the documentation will be generated. This is useful when you want to generate the documentation in a subdirectory of your project.                                                                                                                                                                                                                 | N/A             | No       |
 
 ### Importing to your project
 

package/docs/README.md

@@ -1,84 +1 @@
-# Classes
-## Misc Group
-
-### [nspc.AnotherInterface](/Misc-Group/nspc.AnotherInterface.md)
-
-
-### [nspc.ChildClass](/Misc-Group/nspc.ChildClass.md)
-
-
-### [nspc.GrandparentClass](/Misc-Group/nspc.GrandparentClass.md)
-
-
-### [nspc.InterfaceWithInheritance](/Misc-Group/nspc.InterfaceWithInheritance.md)
-
-
-### [nspc.MemberGrouping](/Misc-Group/nspc.MemberGrouping.md)
-
-
-### [nspc.ParentClass](/Misc-Group/nspc.ParentClass.md)
-
-
-### [nspc.Reference1](/Misc-Group/nspc.Reference1.md)
-
-
-### [nspc.Reference2](/Misc-Group/nspc.Reference2.md)
-
-
-### [nspc.Reference3](/Misc-Group/nspc.Reference3.md)
-
-
-### [nspc.Reference4](/Misc-Group/nspc.Reference4.md)
-
-
-### [nspc.Reference5](/Misc-Group/nspc.Reference5.md)
-
-
-### [nspc.Reference6](/Misc-Group/nspc.Reference6.md)
-
-
-### [nspc.Reference7](/Misc-Group/nspc.Reference7.md)
-
-
-### [nspc.SampleClassWithoutModifier](/Misc-Group/nspc.SampleClassWithoutModifier.md)
-
-
-### [nspc.SampleRestResource](/Misc-Group/nspc.SampleRestResource.md)
-
-Account related operations
-
-
-
-### [nspc.SampleRestResourceWithInnerClass](/Misc-Group/nspc.SampleRestResourceWithInnerClass.md)
-
-Contact related operations
-
-
-
-### [nspc.SampleRestResourceWithoutApexDocs](/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md)
-
-Order related operations
-
-
-## Main
-
-### [nspc.GroupedClass](/Main/nspc.GroupedClass.md)
-
-Uses a block style apex doc
-
-
-
-### [nspc.SampleClass](/Main/nspc.SampleClass.md)
-
-This is a class description. This class relates to [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
-             But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
-             You can also link using this syntax [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
-
-
-## Sample Interfaces
-
-### [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
-
-This is an interface description.
-
-
+Go to [docs](/types/README.md) for more information.

package/docs/types/Classes/nspc.AnotherInterface.md

@@ -0,0 +1,7 @@
+# nspc.AnotherInterface
+
+Some desc
+
+
+**Group** Classes
+

package/docs/types/Classes/nspc.ChildClass.md

@@ -0,0 +1,79 @@
+# nspc.ChildClass
+
+Some desc
+
+
+**Inheritance**
+
+[nspc.GrandparentClass](types/Misc-Group/nspc.GrandparentClass.md)
+ > 
+[nspc.ParentClass](types/Misc-Group/nspc.ParentClass.md)
+ > 
+ChildClass
+
+
+**Implemented types**
+
+[nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
+
+
+**Group** Classes
+
+## Fields
+
+### `private privateStringFromChild` → `String`
+
+
+### `protected protectedGrandParentField` → `String`
+
+*Inherited*
+
+### `protected protectedStringFromParent` → `String`
+
+*Inherited*
+
+This is a protected string, use carefully.
+
+### `public publicStringFromParent` → `String`
+
+*Inherited*
+
+---
+## Properties
+
+### `protected AProp` → `String`
+
+*Inherited*
+
+---
+## Methods
+### `public doSomething()`
+### `public override overridableMethodOverridden()`
+
+This method was overridden.
+
+#### Returns
+
+|Type|Description|
+|---|---|
+|String|A String.|
+
+### `public execute()`
+
+Executes the command.
+
+### `public getValue()`
+
+Returns a value based on the executed command.
+
+#### Returns
+
+|Type|Description|
+|---|---|
+|String|The value|
+
+### `public overridableMethod()`
+
+*Inherited*
+
+---

package/docs/{Main → types/Main}/nspc.GroupedClass.md

@@ -6,5 +6,5 @@ Uses a block style apex doc
 **Group** Main
 
 
-**Test Class** [nspc.SampleClass](/Main/nspc.SampleClass.md)
+**Test Class** [nspc.SampleClass](types/Main/nspc.SampleClass.md)
 

package/docs/{Main → types/Main}/nspc.SampleClass.md

@@ -2,9 +2,9 @@
 
 `NAMESPACEACCESSIBLE`
 
-This is a class description. This class relates to [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
+This is a class description. This class relates to [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
              But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
-             You can also link using this syntax [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
+             You can also link using this syntax [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
 
 
 **Group** Main
@@ -16,15 +16,15 @@ This is a class description. This class relates to [nspc.SampleInterface](/Sampl
 **Author** Cesar Parra
 
 
-**See** [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
+**See** [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
 
 ## Constructors
 ### My Super Group
-##### `SampleClass()`
+##### `public SampleClass()`
 
 `NAMESPACEACCESSIBLE`
 
-Constructs a SampleClass without any arguments. This relates to [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
+Constructs a SampleClass without any arguments. This relates to [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
 
 ###### Throws
 
@@ -36,7 +36,7 @@ Constructs a SampleClass without any arguments. This relates to [nspc.SampleInte
 **CustomAnnotation** A Custom method annotation
 
 
-**See** [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
+**See** [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
 
 ###### Example
 ```apex
@@ -47,7 +47,7 @@ SampleClass sampleInstance = new SampleClass();
 
 ---
 ### Other
-##### `SampleClass(String argument1, String argument2)`
+##### `public SampleClass(String argument1, String argument2)`
 
 Constructs a SampleClass with an argument.
 
@@ -62,28 +62,32 @@ Constructs a SampleClass with an argument.
 ## Fields
 ### Common Constants
 
-* `ANOTHER_CONSTANT` → `String` 
-* `A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ]  - This is a constant.
-* `listOfStrings` → `List<String>` 
+* `public ANOTHER_CONSTANT` → `String` 
+* `public A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ]  - This is a constant.
+* `public listOfStrings` → `List<String>` 
 ---
 ### 'General' Constants
 
-* `GENERAL_ANOTHER_CONSTANT` → `String` 
-* `GENERAL_A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ]  - This is a constant.
+* `public GENERAL_ANOTHER_CONSTANT` → `String` 
+* `public GENERAL_A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ]  - This is a constant.
 ---
 ### Other variables
 
-* `someVariable` → `String` 
+* `public someVariable` → `String` 
+---
+### Other
+
+* `private somePrivateStuff` → `String` 
 ---
 ## Properties
 
-### `AnotherProp` → `Decimal`
+### `public AnotherProp` → `Decimal`
 
 `AURAENABLED` 
 
 This is a Decimal property.
 
-### `MyProp` → `String`
+### `public MyProp` → `String`
 
 `AURAENABLED` 
 `DEPRECATED` 
@@ -93,7 +97,7 @@ This is a String property.
 ---
 ## Methods
 ### A method group
-##### `static sampleMethod(String argument1, String argument2)`
+##### `public static sampleMethod(String argument1, String argument2)`
 
 `NAMESPACEACCESSIBLE`
 
@@ -106,15 +110,11 @@ Executes commands based on the passed in argument.
 |`argument1`|Argument1 to debug|
 |`argument2`|Argument2 to debug|
 
-###### Return
-
-**Type**
+###### Returns
 
-String
-
-**Description**
-
-Empty string
+|Type|Description|
+|---|---|
+|String|Empty string|
 
 ###### Example
 ```apex
@@ -123,7 +123,7 @@ System.debug(result);
 ```
 
 
-##### `static anotherSampleMethod(String arg1)`
+##### `public static anotherSampleMethod(String arg1)`
 
 Something here
 
@@ -132,7 +132,7 @@ Something here
 
 ---
 ### Other
-##### `static call()`
+##### `public static call()`
 
 Calls the method. This methods allows you to call it.
 
@@ -153,14 +153,14 @@ Inner class belonging to SampleClass.
 
 #### Properties
 
-##### `InnerProp` → `String`
+##### `public InnerProp` → `String`
 
 
 Description of the inner property.
 
 ---
 #### Methods
-##### `innerMethod()`
+##### `public innerMethod()`
 
 Executes from the inner class.
 
@@ -172,14 +172,14 @@ Inner class belonging to SampleClass.
 
 #### Properties
 
-##### `InnerProp` → `String`
+##### `public InnerProp` → `String`
 
 
 Description of the inner property.
 
 ---
 #### Methods
-##### `innerMethod()`
+##### `public innerMethod()`
 
 Executes from the inner class.
 

package/docs/types/Misc-Group/nspc.GrandparentClass.md

@@ -0,0 +1,13 @@
+# nspc.GrandparentClass
+## Fields
+
+### `protected protectedGrandParentField` → `String`
+
+
+---
+## Properties
+
+### `protected AProp` → `String`
+
+
+---

package/docs/types/Misc-Group/nspc.InterfaceWithInheritance.md

@@ -0,0 +1,29 @@
+# nspc.InterfaceWithInheritance
+
+**Extended types**
+
+[nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
+, 
+[nspc.AnotherInterface](types/Classes/nspc.AnotherInterface.md)
+## Methods
+### `global execute()`
+
+*Inherited*
+
+
+Executes the command.
+
+### `global getValue()`
+
+*Inherited*
+
+
+Returns a value based on the executed command.
+
+#### Returns
+
+|Type|Description|
+|---|---|
+|String|The value|
+
+---

package/docs/types/Misc-Group/nspc.MemberGrouping.md

@@ -0,0 +1,13 @@
+# nspc.MemberGrouping
+## Fields
+### Group old syntax
+
+* `public anotherInGroup1` → `String` 
+* `public inGroup1` → `String` 
+---
+### Group new syntax
+Group's description
+
+* `public anotherInGroup2` → `String` 
+* `public inGroup2` → `String`  - Description for constant in group 2
+---

package/docs/types/Misc-Group/nspc.ParentClass.md

@@ -0,0 +1,37 @@
+# nspc.ParentClass
+
+**Inheritance**
+
+[nspc.GrandparentClass](types/Misc-Group/nspc.GrandparentClass.md)
+ > 
+ParentClass
+
+## Fields
+
+### `private privateStringFromParent` → `String`
+
+
+### `protected protectedGrandParentField` → `String`
+
+*Inherited*
+
+### `protected protectedStringFromParent` → `String`
+
+
+This is a protected string, use carefully.
+
+### `public publicStringFromParent` → `String`
+
+
+---
+## Properties
+
+### `protected AProp` → `String`
+
+*Inherited*
+
+---
+## Methods
+### `public overridableMethod()`
+### `public overridableMethodOverridden()`
+---

package/docs/types/Misc-Group/nspc.Reference1.md

@@ -0,0 +1,18 @@
+# nspc.Reference1
+## Fields
+
+### `public reference2Member` → `Reference2`
+
+
+This is a reference 2 member. Lorem.
+
+### `public reference3Member` → `Reference3`
+
+
+### `public reference4Collection` → `List<Reference4>`
+
+
+### `public reference5Member` → `Reference5`
+
+
+---

package/docs/types/Misc-Group/nspc.Reference2.md

@@ -0,0 +1,12 @@
+# nspc.Reference2
+## Fields
+
+### `public objectReference` → `Object`
+
+
+This is an object reference.
+
+### `public stringMember` → `String`
+
+
+---

package/docs/types/Misc-Group/nspc.Reference3.md

@@ -0,0 +1,7 @@
+# nspc.Reference3
+## Fields
+
+### `public someBoolean` → `Boolean`
+
+
+---

package/docs/types/Misc-Group/nspc.Reference4.md

@@ -0,0 +1,7 @@
+# nspc.Reference4
+## Fields
+
+### `public someString` → `String`
+
+
+---

package/docs/types/Misc-Group/nspc.Reference5.md

@@ -0,0 +1,7 @@
+# nspc.Reference5
+## Fields
+
+### `public reference6Member` → `Reference6`
+
+
+---

package/docs/{Misc-Group → types/Misc-Group}/nspc.Reference6.md

@@ -1,7 +1,7 @@
 # nspc.Reference6
 ## Fields
 
-### `grandChildString` → `String`
+### `public grandChildString` → `String`
 
 
 This is the grandchild description.

package/docs/types/Misc-Group/nspc.Reference7.md

@@ -0,0 +1,7 @@
+# nspc.Reference7
+## Fields
+
+### `public untypedObject` → `Object`
+
+
+---

package/docs/{Misc-Group → types/Misc-Group}/nspc.SampleClassWithoutModifier.md

@@ -2,7 +2,7 @@
 
 `ISTEST`
 ## Methods
-### `static thisIsAClassWithoutAModifier()`
+### `private static thisIsAClassWithoutAModifier()`
 
 `ISTEST`
 

package/docs/{Misc-Group → types/Misc-Group}/nspc.SampleRestResource.md

@@ -5,7 +5,7 @@
 Account related operations
 
 ## Methods
-### `static doDelete()`
+### `global static doDelete()`
 
 `HTTPDELETE`
 
@@ -32,21 +32,17 @@ Sample HTTP Delete method with references to other types.
 
 **Http Response** statusCode: 307 schema: Reference7[untypedObject:Reference2]
 
-### `static doGet()`
+### `global static doGet()`
 
 `HTTPGET`
 
 This is a sample HTTP Get method
 
-#### Return
+#### Returns
 
-**Type**
-
-Account
-
-**Description**
-
-An Account SObject.
+|Type|Description|
+|---|---|
+|Account|An Account SObject.|
 
 
 **Http Parameter** name: limit in: query required: true description: Limits the number of items on a page schema:   type: integer
@@ -69,21 +65,17 @@ An Account SObject.
 
 **Http Response** statusCode: 100 schema:   type: object   properties:     anotherObject:       description: An object inside of an object       type: object       properties:         message:           type: string         somethingElse:           type: number
 
-### `static doPost(String name, String phone, String website)`
+### `global static doPost(String name, String phone, String website)`
 
 `HTTPPOST`
 
 This is a sample HTTP Post method
 
-#### Return
-
-**Type**
-
-String
-
-**Description**
+#### Returns
 
-A String SObject.
+|Type|Description|
+|---|---|
+|String|A String SObject.|
 
 
 **Summary** Posts an Account 2