npm - @cparra/apexdocs - Versions diffs - 2.25.0 → 3.0.0-alpha.10 - Mend

@cparra/apexdocs 2.25.0 → 3.0.0-alpha.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (431) hide show

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

@@ -1,97 +0,0 @@
-# nspc.ChildClass
-Some desc
-**Inheritance**
-[nspc.GrandparentClass](types/Misc-Group/nspc.GrandparentClass.md)
- &gt;
-[nspc.ParentClass](types/Misc-Group/nspc.ParentClass.md)
- &gt;
-ChildClass
-**Implemented types**
-[nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
-**Group** Classes
-## Fields
-### `private aPrivateString` → `String`
-### `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 void doSomething()`
-### `public void execute()`
-Executes the command.
-### `public String getValue()`
-Returns a value based on the executed command.
-#### Returns
-|Type|Description|
-|---|---|
-|`String`|The value|
-### `public virtual String overridableMethod()`
-*Inherited*
-### `public override String overridableMethodOverridden()`
-This method was overridden.
-#### Returns
-|Type|Description|
-|---|---|
-|`String`|A String.|
-```mermaid
-sequenceDiagram
-    participant dotcom
-    participant iframe
-    participant viewscreen
-    dotcom->>iframe: loads html w/ iframe url
-    iframe->>viewscreen: request template
-    viewscreen->>iframe: html & javascript
-    iframe->>dotcom: iframe ready
-    dotcom->>iframe: set mermaid data on iframe
-    iframe->>iframe: render mermaid
-```
----

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

@@ -1,10 +0,0 @@
-# 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 DELETED Viewed

@@ -1,190 +0,0 @@
-# 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 DELETED Viewed

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

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

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

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

@@ -1,29 +0,0 @@
-# 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 DELETED Viewed

@@ -1,13 +0,0 @@
-# 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 DELETED Viewed

@@ -1,37 +0,0 @@
-# abstract nspc.ParentClass
-**Inheritance**
-[nspc.GrandparentClass](types/Misc-Group/nspc.GrandparentClass.md)
- &gt;
-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 DELETED Viewed

@@ -1,18 +0,0 @@
-# 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 DELETED Viewed

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

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

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

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

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

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

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

package/docs/types/Misc-Group/nspc.Reference6.md DELETED Viewed

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

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

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

package/docs/types/Misc-Group/nspc.SampleClassWithoutModifier.md DELETED Viewed

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

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

@@ -1,211 +0,0 @@
-# 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&lt;Reference1&gt;
-**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
----