@cparra/apexdocs 2.24.0 → 2.25.0-alpha.0

package/examples/plain-markdown/README.md

@@ -0,0 +1,301 @@
+# Template file
+
+# BaseClass Class
+`abstract`
+
+## Namespace
+ns
+
+## Fields
+### `sampleEnumFromBase`
+
+#### Type
+[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
+
+
+---
+
+# ParentInterface Interface
+
+## Namespace
+ns
+
+## Methods
+### `sampleParentMethod()`
+
+### Signature
+```apex
+public void sampleParentMethod()
+``` 
+
+### Returns
+**void**
+
+
+---
+
+# ReferencedEnum Enum
+
+## Namespace
+ns
+
+## Enum Values
+
+
+---
+
+# SampleClass Class
+`virtual`
+
+aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex 
+
+deserunt ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
+
+**Group** SampleGroup
+
+## Namespace
+ns
+
+## Example
+```apex
+SampleClass sample = new SampleClass();
+sample.doSomething();
+```
+
+**Extends**
+[ns.BaseClass](../Miscellaneous/ns.BaseClass.md)
+
+**Implements**
+[ns.SampleInterface](../Miscellaneous/ns.SampleInterface.md), 
+[ns.ParentInterface](../Miscellaneous/ns.ParentInterface.md)
+
+## Fields
+### `name`
+
+This is a sample field.
+
+#### Type
+String
+
+---
+
+### `sampleEnumFromBase`
+
+*Inherited*
+
+#### Type
+[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
+
+## Constructors
+### `SampleClass()`
+
+This is a sample constructor.
+
+### Signature
+```apex
+public SampleClass()
+``` 
+
+---
+### `SampleClass(name)`
+
+### Signature
+```apex
+public SampleClass(String name)
+``` 
+
+### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| name | String |  |
+
+## Methods
+### `sayHello()`
+
+`DEPRECATED`
+
+This is a sample method.
+
+### Signature
+```apex
+public virtual String sayHello()
+``` 
+
+### Returns
+**String**
+
+A string value.
+
+### Example
+```apex
+SampleClass sample = new SampleClass();
+sample.doSomething();
+```
+
+
+---
+
+# SampleEnum Enum
+
+`NAMESPACEACCESSIBLE`
+
+This is a sample enum. This references [ns.ReferencedEnum](../Miscellaneous/ns.ReferencedEnum.md) . 
+
+This description has several lines
+
+**Some Custom** 
+
+**Group** Sample Enums
+
+**Author** John Doe
+
+**Date** 2022-01-01
+
+**See** [ns.ReferencedEnum](../Miscellaneous/ns.ReferencedEnum.md)
+
+## Namespace
+ns
+
+```mermaid
+graph TD
+ A[SampleEnum] -->|references| B[ReferencedEnum]
+ B -->|referenced by| A
+```
+
+## Enum Values
+### VALUE1
+This is value 1
+### VALUE2
+This is value 2
+### VALUE3
+This is value 3
+
+
+---
+
+# SampleException Class
+
+## Namespace
+ns
+
+**Extends**
+Exception
+
+
+---
+
+# SampleInterface Interface
+
+`NAMESPACEACCESSIBLE`
+
+This is a sample interface
+
+**Author** John Doe
+
+**Date** 2020-01-01
+
+**See** [ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
+
+**See** [ns.ReferencedEnum](./ns.ReferencedEnum.md)
+
+## Namespace
+ns
+
+```mermaid
+graph TD
+   A[SampleInterface] -->|extends| B[ParentInterface]
+   B -->|extends| C[GrandParentInterface]
+   C -->|extends| D[GreatGrandParentInterface]
+```
+
+## Example
+```apex
+SampleInterface sampleInterface = new SampleInterface();
+sampleInterface.sampleMethod();
+```
+
+**Extends**
+[ns.ParentInterface](./ns.ParentInterface.md)
+
+## Methods
+### `sampleMethod()`
+
+`NAMESPACEACCESSIBLE`
+
+This is a sample method
+
+**Custom Tag** 
+
+**Another Custom Tag** 
+
+### Signature
+```apex
+public String sampleMethod()
+``` 
+
+### Returns
+**String**
+
+Some return value
+
+### Throws
+[ns.SampleException](./ns.SampleException.md): This is a sample exception
+
+AnotherSampleException: This is another sample exception
+
+```mermaid
+graph TD
+  A[SampleInterface] -->|extends| B[ParentInterface]
+  B -->|extends| C[GrandParentInterface]
+  C -->|extends| D[GreatGrandParentInterface]
+```
+
+### Example
+```apex
+SampleInterface sampleInterface = new SampleInterface();
+sampleInterface.sampleMethod();
+```
+
+---
+
+### `sampleMethodWithParams(param1, param2, theEnum)`
+
+`NAMESPACEACCESSIBLE`
+`DEPRECATED`
+
+This is a sample method with parameters 
+
+Sometimes it won't be possible to find a NonExistent link.
+
+### Signature
+```apex
+public SampleEnum sampleMethodWithParams(String param1, Integer param2, SampleEnum theEnum)
+``` 
+
+### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| param1 | String | This is the first parameter |
+| param2 | Integer | This is the second parameter |
+| theEnum | [ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md) | This is an enum parameter |
+
+### Returns
+**[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)**
+
+Some return value
+
+---
+
+### `sampleParentMethod()`
+
+*Inherited*
+
+### Signature
+```apex
+public void sampleParentMethod()
+``` 
+
+### Returns
+**void**
+
+

package/examples/plain-markdown/config/project-scratch-def.json

@@ -0,0 +1,5 @@
+{
+  "orgName": "cesarparra company",
+  "edition": "Developer",
+  "features": []
+}

package/examples/plain-markdown/force-app/classes/BaseClass.cls

@@ -0,0 +1,3 @@
+public abstract class BaseClass {
+    public SampleEnum sampleEnumFromBase;
+}

package/examples/plain-markdown/force-app/classes/ParentInterface.cls

@@ -0,0 +1,3 @@
+public interface ParentInterface {
+    void sampleParentMethod();
+}

package/examples/plain-markdown/force-app/classes/ReferencedEnum.cls

@@ -0,0 +1,3 @@
+public enum ReferencedEnum {
+
+}

package/examples/plain-markdown/force-app/classes/SampleClass.cls

@@ -0,0 +1,35 @@
+/**
+ * @description aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex
+ *              deserunt ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
+ * @group SampleGroup
+ * @example
+ * SampleClass sample = new SampleClass();
+ * sample.doSomething();
+ */
+public with sharing virtual class SampleClass extends BaseClass implements SampleInterface, ParentInterface {
+    /**
+     * @description This is a sample field.
+     */
+    private final String name;
+
+    /**
+     * @description This is a sample constructor.
+     */
+    public SampleClass() {}
+
+    public SampleClass(String name) {
+        this.name = name;
+    }
+
+    /**
+     * @description This is a sample method.
+     * @return A string value.
+     * @example
+     * SampleClass sample = new SampleClass();
+     * sample.doSomething();
+     */
+    @Deprecated
+    public virtual String sayHello() {
+        return 'Hello';
+    }
+}

package/examples/plain-markdown/force-app/classes/SampleEnum.cls

@@ -0,0 +1,30 @@
+/**
+ * @description This is a sample enum. This references {@link ReferencedEnum}.
+ *
+ * This description has several lines
+ * @group Sample Enums
+ * @author John Doe
+ * @date 2022-01-01
+ * @some-custom Test. I can also have a {@link ReferencedEnum} here.
+ *                    And it can be multiline.
+ * @see ReferencedEnum
+ * @mermaid
+ * graph TD
+ *  A[SampleEnum] -->|references| B[ReferencedEnum]
+ *  B -->|referenced by| A
+ */
+@NamespaceAccessible
+public enum SampleEnum {
+    /**
+     * @description This is value 1
+     */
+    VALUE1,
+    /**
+     * @description This is value 2
+     */
+    VALUE2,
+    /**
+     * @description This is value 3
+     */
+    VALUE3
+}

package/examples/plain-markdown/force-app/classes/SampleException.cls

@@ -0,0 +1 @@
+public class SampleException extends Exception {}

package/examples/plain-markdown/force-app/classes/SampleInterface.cls

@@ -0,0 +1,46 @@
+/**
+ * @description This is a sample interface
+ * @author John Doe
+ * @date 2020-01-01
+ * @see SampleEnum
+ * @see ReferencedEnum
+ * @mermaid
+ * graph TD
+ *    A[SampleInterface] -->|extends| B[ParentInterface]
+ *    B -->|extends| C[GrandParentInterface]
+ *    C -->|extends| D[GreatGrandParentInterface]
+ * @example
+ * SampleInterface sampleInterface = new SampleInterface();
+ * sampleInterface.sampleMethod();
+ */
+@NamespaceAccessible
+public interface SampleInterface extends ParentInterface {
+    /**
+     * @description This is a sample method
+     * @return Some return value
+     * @throws SampleException This is a sample exception
+     * @throws AnotherSampleException This is another sample exception
+     * @custom-tag This is a custom tag
+     * @another-custom-tag This is another custom tag
+     * @mermaid
+     * graph TD
+     *   A[SampleInterface] -->|extends| B[ParentInterface]
+     *   B -->|extends| C[GrandParentInterface]
+     *   C -->|extends| D[GreatGrandParentInterface]
+     * @example
+     * SampleInterface sampleInterface = new SampleInterface();
+     * sampleInterface.sampleMethod();
+     */
+    String sampleMethod();
+
+    /**
+     * @description This is a sample method with parameters
+     *              Sometimes it won't be possible to find a {@link NonExistent} link.
+     * @param param1 This is the first parameter
+     * @param param2 This is the second parameter
+     * @param theEnum This is an enum parameter
+     * @return Some return value
+     */
+    @Deprecated
+    SampleEnum sampleMethodWithParams(String param1, Integer param2, SampleEnum theEnum);
+}