Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,17 +111,17 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f

#### Flags

| Flag | Alias | Description | Default | Required |
|---------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|----------|
| `--sourceDir` | `-s` | The directory where the source files are located. | N/A | Yes |
| `--targetDir` | `-t` | The directory where the generated files will be placed. | `docs` | No |
| `--scope` | `-p` | A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. | `global` | No |
| `--defaultGroupName` | N/A | The default group name to use when a group is not specified. | `Miscellaneous` | No |
| `--namespace` | N/A | The package namespace, if any. If provided, it will be added to the generated files. | N/A | No |
| `--sortAlphabetically` | N/A | Sorts files appearing in the Reference Guide alphabetically, as well as the members of a class, interface or enum alphabetically. If false, the members will be displayed in the same order as the code. | `false` | No |
| `--includeMetadata ` | N/A | Whether to include the file's meta.xml information: Whether it is active and and the API version | `false` | No |
| `--linkingStrategy` | N/A | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none` | `relative` | No |
| `--customObjectGroupName` | N/A | The name under which custom objects will be grouped in the Reference Guide | `Custom Objects` | No |
| Flag | Alias | Description | Default | Required |
|----------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|----------|
| `--sourceDir` | `-s` | The directory where the source files are located. | N/A | Yes |
| `--targetDir` | `-t` | The directory where the generated files will be placed. | `docs` | No |
| `--scope` | `-p` | A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. | `global` | No |
| `--defaultGroupName` | N/A | The default group name to use when a group is not specified. | `Miscellaneous` | No |
| `--namespace` | N/A | The package namespace, if any. If provided, it will be added to the generated files. | N/A | No |
| `--sortAlphabetically` | N/A | Sorts files appearing in the Reference Guide alphabetically, as well as the members of a class, interface or enum alphabetically. If false, the members will be displayed in the same order as the code. | `false` | No |
| `--includeMetadata ` | N/A | Whether to include the file's meta.xml information: Whether it is active and and the API version | `false` | No |
| `--linkingStrategy` | N/A | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none` | `relative` | No |
| `--customObjectsGroupName` | N/A | The name under which custom objects will be grouped in the Reference Guide | `Custom Objects` | No |

##### Linking Strategy

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<apiVersion>62.0</apiVersion>
<status>Active</status>
</ApexClass>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<apiVersion>62.0</apiVersion>
<status>Active</status>
</ApexClass>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<apiVersion>62.0</apiVersion>
<status>Active</status>
</ApexClass>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<apiVersion>62.0</apiVersion>
<status>Active</status>
</ApexClass>
5 changes: 5 additions & 0 deletions examples/changelog/current/classes/SolidService.cls-meta.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<apiVersion>62.0</apiVersion>
<status>Active</status>
</ApexClass>
5 changes: 5 additions & 0 deletions examples/changelog/previous/OldImplementation.cls-meta.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<apiVersion>62.0</apiVersion>
<status>Active</status>
</ApexClass>
5 changes: 5 additions & 0 deletions examples/changelog/previous/SolidService.cls-meta.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<apiVersion>62.0</apiVersion>
<status>Active</status>
</ApexClass>
61 changes: 61 additions & 0 deletions examples/markdown/docs/custom-objects/Event__c.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Event

Represents an event that people can register for.

## API Name
`ns__Event__c`

## Fields
### Description

**API Name**

`ns__Description__c`

**Type**

*LongTextArea*

---
### End Date

**API Name**

`ns__End_Date__c`

**Type**

*Date*

---
### Location

**API Name**

`ns__Location__c`

**Type**

*Location*

---
### Start Date

**API Name**

`ns__Start_Date__c`

**Type**

*Date*

---
### Tag Line

**API Name**

`ns__Tag_Line__c`

**Type**

*Text*
65 changes: 65 additions & 0 deletions examples/markdown/docs/custom-objects/Price_Component__c.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Price Component

## API Name
`ns__Price_Component__c`

## Fields
### Description

**API Name**

`ns__Description__c`

**Type**

*Text*

---
### Expression

The Expression that determines if this price should take effect or not.

**API Name**

`ns__Expression__c`

**Type**

*LongTextArea*

---
### Percent

Use this field to calculate the price based on the list price&#x27;s percentage instead of providing a flat price.

**API Name**

`ns__Percent__c`

**Type**

*Percent*

---
### Price

Use this when the Price Component represents a Flat Price. To represent a Percentage use the Percent field.

**API Name**

`ns__Price__c`

**Type**

*Currency*

---
### Type

**API Name**

`ns__Type__c`

**Type**

*Picklist*
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Product Price Component

## API Name
`ns__Product_Price_Component__c`

## Fields
### Price Component

**API Name**

`ns__Price_Component__c`

**Type**

*MasterDetail*

---
### Product

**API Name**

`ns__Product__c`

**Type**

*MasterDetail*
39 changes: 39 additions & 0 deletions examples/markdown/docs/custom-objects/Product__c.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Product (Custom)

Product that is sold or available for sale.

## API Name
`ns__Product__c`

## Fields
### Description

**API Name**

`ns__Description__c`

**Type**

*Text*

---
### Event

**API Name**

`ns__Event__c`

**Type**

*Lookup*

---
### Features

**API Name**

`ns__Features__c`

**Type**

*LongTextArea*
61 changes: 61 additions & 0 deletions examples/markdown/docs/custom-objects/Sales_Order_Line__c.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Sales Order Line

Represents a line item on a sales order.

## API Name
`ns__Sales_Order_Line__c`

## Fields
### Amount

**API Name**

`ns__Amount__c`

**Type**

*Currency*

---
### Product

**API Name**

`ns__Product__c`

**Type**

*Lookup*

---
### Sales Order

**API Name**

`ns__Sales_Order__c`

**Type**

*MasterDetail*

---
### Source Price Component

**API Name**

`ns__Source_Price_Component__c`

**Type**

*Lookup*

---
### Type

**API Name**

`ns__Type__c`

**Type**

*Picklist*
6 changes: 6 additions & 0 deletions examples/markdown/docs/custom-objects/Sales_Order__c.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Sales Order

Custom object for tracking sales orders.

## API Name
`ns__Sales_Order__c`
39 changes: 39 additions & 0 deletions examples/markdown/docs/custom-objects/Speaker__c.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Speaker

Represents a speaker at an event.

## API Name
`ns__Speaker__c`

## Fields
### About

**API Name**

`ns__About__c`

**Type**

*LongTextArea*

---
### Event

**API Name**

`ns__Event__c`

**Type**

*MasterDetail*

---
### Person

**API Name**

`ns__Person__c`

**Type**

*MasterDetail*
Loading
Loading