@cparra/apexdocs 3.0.0-beta.1 → 3.0.0

package/examples/docsify/docs/miscellaneous/SomeDto.md

@@ -0,0 +1,244 @@
+# SomeDto Class
+
+Some description
+
+**See** [ASampleClass](miscellaneous/ASampleClass.md)
+
+## Properties
+### `Items`
+
+`AURAENABLED`
+
+#### Signature
+```apex
+public Items
+```
+
+#### Type
+List<CartItemDto>
+
+---
+
+### `SubTotal`
+
+`AURAENABLED`
+
+#### Signature
+```apex
+public SubTotal
+```
+
+#### Type
+Decimal
+
+---
+
+### `Total`
+
+`AURAENABLED`
+
+#### Signature
+```apex
+public Total
+```
+
+#### Type
+Decimal
+
+---
+
+### `Discounts`
+
+`AURAENABLED`
+
+#### Signature
+```apex
+public Discounts
+```
+
+#### Type
+Decimal
+
+## Constructors
+### `SomeDto(proForma)`
+
+Constructs a CartDto
+
+#### Signature
+```apex
+public SomeDto(nams.Order proForma)
+```
+
+#### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| proForma | nams.Order | The pro forma |
+
+## Classes
+### CartItemDto Class
+
+Used in cartItem.html
+
+#### Properties
+##### `Id`
+
+`AURAENABLED`
+
+Id Unique identifier for this object.
+
+###### Signature
+```apex
+public Id
+```
+
+###### Type
+String
+
+---
+
+##### `Description`
+
+`AURAENABLED`
+
+Description The description to display for this item.
+
+###### Signature
+```apex
+public Description
+```
+
+###### Type
+String
+
+---
+
+##### `Quantity`
+
+`AURAENABLED`
+
+Quantity Amount of this item currently in the cart.
+
+###### Signature
+```apex
+public Quantity
+```
+
+###### Type
+Decimal
+
+---
+
+##### `Price`
+
+`AURAENABLED`
+
+Price Calculated price for this item.
+
+###### Signature
+```apex
+public Price
+```
+
+###### Type
+Decimal
+
+---
+
+##### `CurrencyCode`
+
+`AURAENABLED`
+
+The currency code for this item.
+
+###### Signature
+```apex
+public CurrencyCode
+```
+
+###### Type
+String
+
+---
+
+##### `ProductImage`
+
+`AURAENABLED`
+
+ProductImage Main display image to display for this item.
+
+###### Signature
+```apex
+public ProductImage
+```
+
+###### Type
+String
+
+---
+
+##### `IsDiscounted`
+
+`AURAENABLED`
+
+IsDiscounted Whether the item has been discounted or not.
+
+###### Signature
+```apex
+public IsDiscounted
+```
+
+###### Type
+Boolean
+
+---
+
+##### `AdjustedPrice`
+
+`AURAENABLED`
+
+AdjustedPrice If the item has been discounted, this contains the adjusted (lower) price.
+
+###### Signature
+```apex
+public AdjustedPrice
+```
+
+###### Type
+Decimal
+
+---
+
+##### `DiscountReason`
+
+`AURAENABLED`
+
+DiscountReason If the item has been discounted, this contains a human-readable reason for the discount.
+
+###### Signature
+```apex
+public DiscountReason
+```
+
+###### Type
+String
+
+#### Constructors
+##### `CartItemDto(id, description, quantity, price, currencyCode, productImage, isDiscounted, adjustedAmount, discountReason)`
+
+###### Signature
+```apex
+public CartItemDto(String id, String description, Decimal quantity, Decimal price, String currencyCode, String productImage, Boolean isDiscounted, Decimal adjustedAmount, String discountReason)
+```
+
+###### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| id | String |  |
+| description | String |  |
+| quantity | Decimal |  |
+| price | Decimal |  |
+| currencyCode | String |  |
+| productImage | String |  |
+| isDiscounted | Boolean |  |
+| adjustedAmount | Decimal |  |
+| discountReason | String |  |

package/examples/docsify/docs/sample-classes/SampleClass.md

@@ -0,0 +1,171 @@
+# SampleClass Class
+
+`NAMESPACEACCESSIBLE`
+
+This is a class description.
+
+**Group** Sample Classes
+
+**See** [SampleInterface](sample-interfaces/SampleInterface.md)
+
+## Properties
+### `MyProp`
+
+This is a String property.
+
+#### Signature
+```apex
+public MyProp
+```
+
+#### Type
+String
+
+---
+
+### `AnotherProp`
+
+This is a Decimal property.
+
+#### Signature
+```apex
+public AnotherProp
+```
+
+#### Type
+Decimal
+
+## Constructors
+### `SampleClass()`
+
+`NAMESPACEACCESSIBLE`
+
+Constructs a SampleClass without any arguments.
+
+#### Signature
+```apex
+public SampleClass()
+```
+
+#### Example
+```apex
+SampleClass sampleInstance = new SampleClass();
+```
+
+---
+
+### `SampleClass(argument)`
+
+Constructs a SampleClass with an argument.
+
+#### Signature
+```apex
+public SampleClass(String argument)
+```
+
+#### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| argument | String | Some argument |
+
+## Methods
+### `someTestMethod(argument)`
+
+`NAMESPACEACCESSIBLE`
+
+Executes commands based on the passed in argument.
+
+#### Signature
+```apex
+public static String someTestMethod(String argument)
+```
+
+#### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| argument | String |  |
+
+#### Return Type
+**String**
+
+#### Example
+```apex
+String result = SampleClass.testMethod();
+System.debug(result);
+```
+
+---
+
+### `call()`
+
+Calls the method. 
+This methods allows you to call it.
+
+#### Signature
+```apex
+public static void call()
+```
+
+#### Return Type
+**void**
+
+## Classes
+### InnerClass Class
+
+Inner class belonging to SampleClass.
+
+#### Properties
+##### `InnerProp`
+
+Description of the inner property.
+
+###### Signature
+```apex
+public InnerProp
+```
+
+###### Type
+String
+
+#### Methods
+##### `innerMethod()`
+
+Executes from the inner class.
+
+###### Signature
+```apex
+public void innerMethod()
+```
+
+###### Return Type
+**void**
+
+### AnotherInnerClass Class
+
+Inner class belonging to SampleClass.
+
+#### Properties
+##### `InnerProp`
+
+Description of the inner property.
+
+###### Signature
+```apex
+public InnerProp
+```
+
+###### Type
+String
+
+#### Methods
+##### `innerMethod()`
+
+Executes from the inner class.
+
+###### Signature
+```apex
+public void innerMethod()
+```
+
+###### Return Type
+**void**

package/examples/docsify/docs/sample-interfaces/SampleInterface.md

@@ -0,0 +1,36 @@
+# SampleInterface Interface
+
+This is an interface description.
+
+**Group** Sample Interfaces
+
+**See** [SampleClass](sample-classes/SampleClass.md)
+
+## Methods
+### `execute()`
+
+Executes the command.
+
+#### Signature
+```apex
+public void execute()
+```
+
+#### Return Type
+**void**
+
+---
+
+### `getValue()`
+
+Returns a value based on the executed command.
+
+#### Signature
+```apex
+public String getValue()
+```
+
+#### Return Type
+**String**
+
+Empty value