@cparra/apexdocs 2.25.0-alpha.8 → 2.25.0

package/docs/types/Main/nspc.GroupedClass.md

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

package/docs/types/Main/nspc.SampleClass.md

@@ -0,0 +1,190 @@
+# virtual nspc.SampleClass
+
+`NAMESPACEACCESSIBLE`
+
+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](types/Sample-Interfaces/nspc.SampleInterface.md)
+
+
+**Group** Main
+
+
+**CustomAnnotation** A Custom annotation
+
+
+**Author** Cesar Parra
+
+
+**See** [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
+
+## Constructors
+### My Super Group
+##### `public SampleClass()`
+
+`NAMESPACEACCESSIBLE`
+
+Constructs a SampleClass without any arguments. This relates to [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
+
+###### Throws
+
+|Exception|Description|
+|---|---|
+|`ExcName`|some exception|
+
+
+**CustomAnnotation** A Custom method annotation
+
+
+**See** [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
+
+###### Example
+```apex
+// Example
+SampleClass sampleInstance = new SampleClass();
+```
+
+
+---
+### Other
+##### `public SampleClass(String argument1, String argument2)`
+
+Constructs a SampleClass with an argument.
+
+###### Parameters
+
+|Param|Description|
+|---|---|
+|`argument1`|Argument1 definition|
+|`argument2`|Argument2 definition|
+
+---
+## Fields
+### Common Constants
+
+* `public A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ]  - This is a constant.
+* `public ANOTHER_CONSTANT` → `String` 
+* `public listOfStrings` → `List<String>` 
+---
+### 'General' Constants
+
+* `public GENERAL_A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ]  - This is a constant.
+* `public GENERAL_ANOTHER_CONSTANT` → `String` 
+---
+### Other
+
+* `private somePrivateStuff` → `String` 
+---
+### Other variables
+
+* `public someVariable` → `String` 
+---
+## Properties
+
+### `public AnotherProp` → `Decimal`
+
+`AURAENABLED` 
+
+This is a Decimal property.
+
+### `public MyProp` → `String`
+
+`AURAENABLED` 
+`DEPRECATED` 
+
+This is a String property.
+
+---
+## Methods
+### A method group
+##### `public static String anotherSampleMethod(String arg1)`
+
+Something here
+
+
+**Arg1** The arg1 description
+
+##### `public static String 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|
+
+###### Returns
+
+|Type|Description|
+|---|---|
+|`String`|Empty string|
+
+###### Example
+```apex
+String result = SampleClass.testMethod();
+System.debug(result);
+```
+
+
+##### `public static Map<Id,List<String>> yetAnotherSampleMethod(String arg1)`
+---
+### Other
+##### `public static void 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
+
+##### `public InnerProp` → `String`
+
+
+Description of the inner property.
+
+---
+#### Methods
+##### `public void innerMethod()`
+
+Executes from the inner class.
+
+---
+
+### InnerClass
+
+Inner class belonging to SampleClass.
+
+#### Properties
+
+##### `public InnerProp` → `String`
+
+
+Description of the inner property.
+
+---
+#### Methods
+##### `public void innerMethod()`
+
+Executes from the inner class.
+
+---
+
+---

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

@@ -0,0 +1,4 @@
+# nspc.EscapedAnnotations
+
+This sentence has an `@embedded` annotation.
+

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

@@ -0,0 +1,13 @@
+# virtual 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 void execute()`
+
+*Inherited*
+
+
+Executes the command.
+
+### `global String 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`  - Description for another constant in group 2
+* `public inGroup2` → `String`  - Description for constant in group 2
+---

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

@@ -0,0 +1,37 @@
+# abstract 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 virtual String overridableMethod()`
+### `public virtual String 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/types/Misc-Group/nspc.Reference6.md

@@ -0,0 +1,9 @@
+# nspc.Reference6
+## Fields
+
+### `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/types/Misc-Group/nspc.SampleClassWithoutModifier.md

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

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

@@ -0,0 +1,211 @@
+# nspc.SampleRestResource
+
+`RESTRESOURCE`
+
+Account related operations
+
+## Methods
+### `global static void doDelete()`
+
+`HTTPDELETE`
+
+Sample HTTP Delete method with references to other types.
+
+
+**Http Parameter** name: limit
+in: header
+required: true
+description: My sample description.
+schema: SampleClass
+
+
+**Http Response** statusCode: 200
+schema: SampleClass
+
+
+**Http Response** statusCode: 500
+schema: SampleClass
+
+
+**Http Response** statusCode: 304
+schema: ChildClass
+
+
+**Http Response** statusCode: 305
+schema: Reference1
+
+
+**Http Response** statusCode: 306
+schema: List<Reference1>
+
+
+**Http Response** statusCode: 307
+schema: Reference7[untypedObject:Reference2]
+
+### `global static Account doGet()`
+
+`HTTPGET`
+
+This is a sample HTTP Get method
+
+#### Returns
+
+|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
+
+
+**Http Parameter** name: complex
+in: cookie
+description: A more complex schema
+schema:
+  type: array
+  items:
+    type: object
+    properties:
+      name:
+        type: string
+
+
+**Http Response** statusCode: 200
+schema:
+  type: object
+  properties:
+    id:
+      type: string
+      description: The super Id.
+    name:
+      type: string
+    phone:
+      type: string
+      format: byte
+
+
+**Http Response** statusCode: 500
+schema:
+  type: string
+
+
+**Http Response** statusCode: 304
+schema:
+  type: object
+  properties:
+    error:
+      type: string
+
+
+**Http Response** statusCode: 400
+schema:
+  type: array
+  items:
+    type: object
+    properties:
+      name:
+        type: string
+
+
+**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
+
+### `global static String doPost(String name, String phone, String website)`
+
+`HTTPPOST`
+
+This is a sample HTTP Post method
+
+#### Returns
+
+|Type|Description|
+|---|---|
+|`String`|A String SObject.|
+
+
+**Summary** Posts an Account 2
+
+
+**Http Parameter** name: limit
+in: query
+required: true
+description: Limits the number of items on a page
+schema:
+  type: integer
+
+
+**Http Parameter** name: complex
+in: cookie
+description: A more complex schema
+schema:
+  type: array
+  items:
+    type: object
+    properties:
+      name:
+        type: string
+
+
+**Http Request Body** description: This is an example of a request body
+required: true
+schema:
+  type: array
+  items:
+    type: object
+    properties:
+      name:
+        type: string
+
+
+**Http Response** statusCode: 200
+schema:
+  type: object
+  properties:
+    id:
+      type: string
+      description: The super Id.
+    name:
+      type: string
+    phone:
+      type: string
+      format: byte
+
+
+**Http Response** statusCode: 500
+schema:
+  type: string
+
+
+**Http Response** statusCode: 304
+schema:
+  type: object
+  properties:
+    error:
+      type: string
+
+
+**Http Response** statusCode: 400
+schema:
+  type: array
+  items:
+    type: object
+    properties:
+      name:
+        type: string
+
+---

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

@@ -0,0 +1,34 @@
+# nspc.SampleRestResourceWithInnerClass
+
+`RESTRESOURCE`
+
+Contact related operations
+
+## Methods
+### `global static InnerClass doGet()`
+
+`HTTPGET`
+
+This is a sample HTTP Get method
+
+#### Returns
+
+|Type|Description|
+|---|---|
+|`InnerClass`|A SampleRestResourceWithInnerClass.InnerClass Object.|
+
+
+**Http Response** statusCode: 200
+schema: SampleRestResourceWithInnerClass.InnerClass
+
+---
+## Classes
+### InnerClass
+#### Fields
+
+##### `global stringMember` → `String`
+
+
+---
+
+---

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

@@ -0,0 +1,14 @@
+# nspc.SampleRestResourceWithoutApexDocs
+
+`RESTRESOURCE`
+
+Order related operations
+
+## Methods
+### `global static String doGet(String param1, Reference1 param2)`
+
+`HTTPGET`
+### `global static String doPatch(String param1, Reference1 param2)`
+
+`HTTPPATCH`
+---