@cparra/apexdocs 2.7.0 → 2.8.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Cesar Parra
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 Cesar Parra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/docs/API/SampleClassWithoutModifier.md

@@ -1,11 +1,11 @@
-# SampleClassWithoutModifier
-
-`ISTEST`
-## Methods
-### `static thisIsAClassWithoutAModifier()`
-
-`ISTEST`
-
-This is a test method
-
----
+# SampleClassWithoutModifier
+
+`ISTEST`
+## Methods
+### `static thisIsAClassWithoutAModifier()`
+
+`ISTEST`
+
+This is a test method
+
+---

package/docs/Main/GroupedClass.md

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

package/docs/Main/SampleClass.md

@@ -1,188 +1,188 @@
-# SampleClass
-
-`NAMESPACEACCESSIBLE`
-
-`APIVERSION: 54`
-
-`STATUS: ACTIVE`
-
-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)
-
-
-**Group** Main
-
-
-**CustomAnnotation** A Custom annotation
-
-
-**Author** Cesar Parra
-
-
-**See** [SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-## 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.
----
-### 'General' Constants
-
-* `GENERAL_ANOTHER_CONSTANT` → `String` 
-* `GENERAL_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
-
-
-**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.
-
----
-
----
+# SampleClass
+
+`NAMESPACEACCESSIBLE`
+
+`APIVERSION: 54`
+
+`STATUS: ACTIVE`
+
+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)
+
+
+**Group** Main
+
+
+**CustomAnnotation** A Custom annotation
+
+
+**Author** Cesar Parra
+
+
+**See** [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+
+## 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` (*Inherited*)  
+* `A_CONSTANT` → `String` (*Inherited*)  [`NAMESPACEACCESSIBLE` ]  - This is a constant.
+---
+### 'General' Constants
+
+* `GENERAL_ANOTHER_CONSTANT` → `String` (*Inherited*)  
+* `GENERAL_A_CONSTANT` → `String` (*Inherited*)  [`NAMESPACEACCESSIBLE` ]  - This is a constant.
+---
+### Other variables
+
+* `someVariable` → `String` (*Inherited*)  
+---
+## 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
+
+
+**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.
+
+---
+
+---

package/docs/Misc-Group/AnotherInterface.md

@@ -0,0 +1 @@
+# AnotherInterface

package/docs/Misc-Group/ChildClass.md

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

package/docs/Misc-Group/GrandparentClass.md

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

package/docs/Misc-Group/InterfaceWithInheritance.md

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

package/docs/Misc-Group/ParentClass.md

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

package/docs/Misc-Group/SampleClassWithoutModifier.md

@@ -1,11 +1,11 @@
-# SampleClassWithoutModifier
-
-`ISTEST`
-## Methods
-### `static thisIsAClassWithoutAModifier()`
-
-`ISTEST`
-
-This is a test method
-
----
+# SampleClassWithoutModifier
+
+`ISTEST`
+## Methods
+### `static thisIsAClassWithoutAModifier()`
+
+`ISTEST`
+
+This is a test method
+
+---