@cparra/apexdocs 2.22.0 → 2.23.0

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

@@ -21,6 +21,9 @@ ChildClass
 
 ## Fields
 
+### `private aPrivateString` → `String`
+
+
 ### `private privateStringFromChild` → `String`
 
 
@@ -48,6 +51,24 @@ This is a protected string, use carefully.
 ---
 ## 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.
@@ -73,22 +94,4 @@ sequenceDiagram
 ```
 
 
-### `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*
-
 ---

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

@@ -62,23 +62,23 @@ Constructs a SampleClass with an argument.
 ## Fields
 ### Common Constants
 
-* `public ANOTHER_CONSTANT` → `String` 
 * `public A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ]  - This is a constant.
+* `public ANOTHER_CONSTANT` → `String` 
 * `public listOfStrings` → `List<String>` 
 ---
 ### 'General' Constants
 
-* `public GENERAL_ANOTHER_CONSTANT` → `String` 
 * `public GENERAL_A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ]  - This is a constant.
----
-### Other variables
-
-* `public someVariable` → `String` 
+* `public GENERAL_ANOTHER_CONSTANT` → `String` 
 ---
 ### Other
 
 * `private somePrivateStuff` → `String` 
 ---
+### Other variables
+
+* `public someVariable` → `String` 
+---
 ## Properties
 
 ### `public AnotherProp` → `Decimal`
@@ -97,6 +97,13 @@ 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`
@@ -123,13 +130,6 @@ System.debug(result);
 ```
 
 
-##### `public static String anotherSampleMethod(String arg1)`
-
-Something here
-
-
-**Arg1** The arg1 description
-
 ##### `public static Map<Id,List<String>> yetAnotherSampleMethod(String arg1)`
 ---
 ### Other

package/examples/force-app/main/default/classes/AnotherInterface.cls

@@ -1,16 +1,16 @@
-/**
- * @description Some desc
- * @group Classes
- * @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
- */
-public interface AnotherInterface{}
+/**
+ * @description Some desc
+ * @group Classes
+ * @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
+ */
+public interface AnotherInterface{}

package/examples/force-app/main/default/classes/ChildClass.cls

@@ -1,41 +1,42 @@
-/**
- * @description Some desc
- * @group Classes
- */
-public class ChildClass extends ParentClass implements SampleInterface {
-    private String privateStringFromChild;
-
-    public void doSomething() {
-        System.debug('Do something');
-    }
-
-    /**
-     * @description This method was overridden.
-     * @return 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
-     */
-    public override String overridableMethodOverridden() {
-        return null ?? '';
-    }
-
-    /**
-     * @description Executes the command.
-     */
-    public void execute();
-
-    /**
-     * @description Returns a value based on the executed command.
-     * @return The value
-     */
-    public String getValue();
-}
+/**
+ * @description Some desc
+ * @group Classes
+ */
+public class ChildClass extends ParentClass implements SampleInterface {
+    private String privateStringFromChild;
+    private String aPrivateString;
+
+    public void doSomething() {
+        System.debug('Do something');
+    }
+
+    /**
+     * @description This method was overridden.
+     * @return 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
+     */
+    public override String overridableMethodOverridden() {
+        return null ?? '';
+    }
+
+    /**
+     * @description Executes the command.
+     */
+    public void execute();
+
+    /**
+     * @description Returns a value based on the executed command.
+     * @return The value
+     */
+    public String getValue();
+}

package/examples/force-app/main/default/classes/EscapedAnnotations.cls

@@ -1,5 +1,5 @@
-/**
- * @description This sentence has an `@embedded` annotation.
- */
-public with sharing class EscapedAnnotations {
-}
+/**
+ * @description This sentence has an `@embedded` annotation.
+ */
+public with sharing class EscapedAnnotations {
+}

package/examples/force-app/main/default/classes/GrandparentClass.cls

@@ -1,5 +1,5 @@
-public virtual class GrandparentClass {
-    protected String protectedGrandParentField;
-
-    protected String AProp { get; set; }
+public virtual class GrandparentClass {
+    protected String protectedGrandParentField;
+
+    protected String AProp { get; set; }
 }

package/examples/force-app/main/default/classes/GroupedClass.cls

@@ -1,8 +1,8 @@
-/**********************************************************
-Uses a block style apex doc
-@group           Main
-@test-class      {@link SampleClass}
-***********************************************************/
-public class GroupedClass {
-
-}
+/**********************************************************
+Uses a block style apex doc
+@group           Main
+@test-class      {@link SampleClass}
+***********************************************************/
+public class GroupedClass {
+
+}

package/examples/force-app/main/default/classes/MemberGrouping.cls

@@ -1,17 +1,17 @@
-public class MemberGrouping {
-    // @start-group Group old syntax
-    public static final String inGroup1;
-    public static final String anotherInGroup1;
-    // @end-group
-
-    /**
-     * @start-group Group new syntax
-     * @description Group's description
-     */
-
-    /** @description Description for constant in group 2 */
-    public static final String inGroup2;
-    /** @description Description for another constant in group 2 @future annotation */
-    public static final String anotherInGroup2;
-    /** @end-group */
-}
+public class MemberGrouping {
+    // @start-group Group old syntax
+    public static final String inGroup1;
+    public static final String anotherInGroup1;
+    // @end-group
+
+    /**
+     * @start-group Group new syntax
+     * @description Group's description
+     */
+
+    /** @description Description for constant in group 2 */
+    public static final String inGroup2;
+    /** @description Description for another constant in group 2 @future annotation */
+    public static final String anotherInGroup2;
+    /** @end-group */
+}

package/examples/force-app/main/default/classes/ParentClass.cls

@@ -1,16 +1,16 @@
-public abstract class ParentClass extends GrandparentClass{
-    private String privateStringFromParent;
-    /**
-     * @description This is a protected string, use carefully.
-     */
-    protected String protectedStringFromParent;
-    public String publicStringFromParent;
-
-    public virtual String overridableMethod() {
-        return '';
-    }
-
-    public virtual String overridableMethodOverridden() {
-        return '';
-    }
-}
+public abstract class ParentClass extends GrandparentClass{
+    private String privateStringFromParent;
+    /**
+     * @description This is a protected string, use carefully.
+     */
+    protected String protectedStringFromParent;
+    public String publicStringFromParent;
+
+    public virtual String overridableMethod() {
+        return '';
+    }
+
+    public virtual String overridableMethodOverridden() {
+        return '';
+    }
+}

package/examples/force-app/main/default/classes/SampleClass.cls

@@ -1,166 +1,166 @@
-/**
- * @description This is a class description. This class relates to {@link SampleInterface}
- *              But this {@link ClassThatDoesNotExist} does not exist.
- *              You can also link using this syntax <<SampleInterface>>
- * @group Main
- * @CustomAnnotation A Custom annotation
- * @author Cesar Parra
- * @see SampleInterface
- */
-@NamespaceAccessible
-public virtual with sharing class SampleClass {
-    /**
-     * @description This is a namespace accessible enum
-     */
-    @NamespaceAccessible
-    public enum InnerEnum {
-        A,
-        B,
-        C
-    }
-
-    // @start-group Common Constants
-
-    public List<String> listOfStrings;
-
-    /**
-     * @description This is a constant.
-     */
-    @NamespaceAccessible
-    public static final String A_CONSTANT = 'My Constant Value';
-    public static final String ANOTHER_CONSTANT = 'My Constant Value';
-    // @end-group
-
-    // @start-group 'General' Constants
-    /**
-     * @description This is a constant.
-     */
-    @NamespaceAccessible
-    public static final String GENERAL_A_CONSTANT = 'My Constant Value';
-    public static final String GENERAL_ANOTHER_CONSTANT = 'My Constant Value';
-    // @end-group
-
-    // @start-group Other variables
-    public String someVariable = 'test';
-    // @end-group
-
-    // @start-group My Super Group
-    /**
-     * @description Constructs a SampleClass without any arguments. This relates to {@link SampleInterface}
-     * @throws ExcName some exception
-     * @CustomAnnotation A Custom method annotation
-     * @see SampleInterface
-     * @example
-     * // Example
-     * SampleClass sampleInstance = new SampleClass();
-     */
-    @NamespaceAccessible
-    public SampleClass() {
-        System.debug('Constructor');
-    }
-    // @end-group
-
-    /**
-     * @description Constructs a SampleClass with an argument.
-     * @param argument1 Argument1 definition
-     * @param argument2 Argument2 definition
-     */
-    public SampleClass(String argument1, String argument2) {
-        System.debug('Constructor');
-    }
-
-
-    // @start-group A method group
-    /**
-     * @description Executes commands based on the passed in argument.
-     * @example
-     * String result = SampleClass.testMethod();
-     * System.debug(result);
-     * @param argument1 Argument1 to debug
-     * @param argument2 Argument2 to debug
-     * @return Empty string
-     */
-    @NamespaceAccessible
-    public static String sampleMethod(String argument1, String argument2) {
-        System.debug('Execute');
-        return '';
-    }
-
-    /**
-     * @description Something here
-     * @arg1 The arg1 description
-     */
-    public static String anotherSampleMethod(String arg1) {
-        System.debug('something');
-        return '';
-    }
-
-    public static Map<Id, List<String>> yetAnotherSampleMethod(String arg1) {
-        System.debug('something');
-        return new Map<Id, List<String>>();
-    }
-    // @end-group
-
-
-    /**
-     * @description Calls the method.
-     * This methods allows you to call it.
-     */
-    public static void call() {
-    }
-
-    /**
-     * @description This is a String property.
-     */
-    @AuraEnabled
-    @Deprecated
-    public String MyProp { get; set; }
-
-    /**
-     * @description This is a Decimal property.
-     */
-    @AuraEnabled
-    public Decimal AnotherProp { get; private set; }
-
-    private String somePrivateStuff;
-
-    /**
-     * @description Inner class belonging to SampleClass.
-     */
-    public class InnerClass {
-        /**
-         * @description Description of the inner property.
-         */
-        public String InnerProp {
-            get;
-            set;
-        }
-
-        /**
-         * @description Executes from the inner class.
-         */
-        public void innerMethod() {
-            System.debug('Executing inner method.');
-        }
-    }
-
-    /**
-     * @description Inner class belonging to SampleClass.
-     */
-    public class AnotherInnerClass {
-        /**
-         * @description Description of the inner property.
-         */
-        public String InnerProp {
-            get;
-            set;
-        }
-
-        /**
-         * @description Executes from the inner class.
-         */
-        public void innerMethod() {
-            System.debug('Executing inner method.');
-        }
-    }
-}
+/**
+ * @description This is a class description. This class relates to {@link SampleInterface}
+ *              But this {@link ClassThatDoesNotExist} does not exist.
+ *              You can also link using this syntax <<SampleInterface>>
+ * @group Main
+ * @CustomAnnotation A Custom annotation
+ * @author Cesar Parra
+ * @see SampleInterface
+ */
+@NamespaceAccessible
+public virtual with sharing class SampleClass {
+    /**
+     * @description This is a namespace accessible enum
+     */
+    @NamespaceAccessible
+    public enum InnerEnum {
+        A,
+        B,
+        C
+    }
+
+    // @start-group Common Constants
+
+    public List<String> listOfStrings;
+
+    /**
+     * @description This is a constant.
+     */
+    @NamespaceAccessible
+    public static final String A_CONSTANT = 'My Constant Value';
+    public static final String ANOTHER_CONSTANT = 'My Constant Value';
+    // @end-group
+
+    // @start-group 'General' Constants
+    /**
+     * @description This is a constant.
+     */
+    @NamespaceAccessible
+    public static final String GENERAL_A_CONSTANT = 'My Constant Value';
+    public static final String GENERAL_ANOTHER_CONSTANT = 'My Constant Value';
+    // @end-group
+
+    // @start-group Other variables
+    public String someVariable = 'test';
+    // @end-group
+
+    // @start-group My Super Group
+    /**
+     * @description Constructs a SampleClass without any arguments. This relates to {@link SampleInterface}
+     * @throws ExcName some exception
+     * @CustomAnnotation A Custom method annotation
+     * @see SampleInterface
+     * @example
+     * // Example
+     * SampleClass sampleInstance = new SampleClass();
+     */
+    @NamespaceAccessible
+    public SampleClass() {
+        System.debug('Constructor');
+    }
+    // @end-group
+
+    /**
+     * @description Constructs a SampleClass with an argument.
+     * @param argument1 Argument1 definition
+     * @param argument2 Argument2 definition
+     */
+    public SampleClass(String argument1, String argument2) {
+        System.debug('Constructor');
+    }
+
+
+    // @start-group A method group
+    /**
+     * @description Executes commands based on the passed in argument.
+     * @example
+     * String result = SampleClass.testMethod();
+     * System.debug(result);
+     * @param argument1 Argument1 to debug
+     * @param argument2 Argument2 to debug
+     * @return Empty string
+     */
+    @NamespaceAccessible
+    public static String sampleMethod(String argument1, String argument2) {
+        System.debug('Execute');
+        return '';
+    }
+
+    /**
+     * @description Something here
+     * @arg1 The arg1 description
+     */
+    public static String anotherSampleMethod(String arg1) {
+        System.debug('something');
+        return '';
+    }
+
+    public static Map<Id, List<String>> yetAnotherSampleMethod(String arg1) {
+        System.debug('something');
+        return new Map<Id, List<String>>();
+    }
+    // @end-group
+
+
+    /**
+     * @description Calls the method.
+     * This methods allows you to call it.
+     */
+    public static void call() {
+    }
+
+    /**
+     * @description This is a String property.
+     */
+    @AuraEnabled
+    @Deprecated
+    public String MyProp { get; set; }
+
+    /**
+     * @description This is a Decimal property.
+     */
+    @AuraEnabled
+    public Decimal AnotherProp { get; private set; }
+
+    private String somePrivateStuff;
+
+    /**
+     * @description Inner class belonging to SampleClass.
+     */
+    public class InnerClass {
+        /**
+         * @description Description of the inner property.
+         */
+        public String InnerProp {
+            get;
+            set;
+        }
+
+        /**
+         * @description Executes from the inner class.
+         */
+        public void innerMethod() {
+            System.debug('Executing inner method.');
+        }
+    }
+
+    /**
+     * @description Inner class belonging to SampleClass.
+     */
+    public class AnotherInnerClass {
+        /**
+         * @description Description of the inner property.
+         */
+        public String InnerProp {
+            get;
+            set;
+        }
+
+        /**
+         * @description Executes from the inner class.
+         */
+        public void innerMethod() {
+            System.debug('Executing inner method.');
+        }
+    }
+}