From a9997962c89d9ac2424b35177d2e48b264c05fdc Mon Sep 17 00:00:00 2001 From: cesarParra Date: Wed, 23 Oct 2024 11:07:38 -0400 Subject: [PATCH 1/3] Fixing typo with CLI configuration name --- README.md | 22 +- .../markdown/docs/custom-objects/Event__c.md | 61 ++++ .../docs/custom-objects/Price_Component__c.md | 65 ++++ .../Product_Price_Component__c.md | 26 ++ .../docs/custom-objects/Product__c.md | 39 +++ .../custom-objects/Sales_Order_Line__c.md | 61 ++++ .../docs/custom-objects/Sales_Order__c.md | 6 + .../docs/custom-objects/Speaker__c.md | 39 +++ examples/markdown/docs/index.md | 110 +------ .../markdown/docs/miscellaneous/BaseClass.md | 16 - .../miscellaneous/MultiInheritanceClass.md | 72 ---- .../docs/miscellaneous/ParentInterface.md | 15 - .../docs/miscellaneous/ReferencedEnum.md | 8 - .../docs/miscellaneous/SampleException.md | 24 -- .../docs/miscellaneous/SampleInterface.md | 116 ------- examples/markdown/docs/miscellaneous/Url.md | 311 ------------------ .../markdown/docs/sample-enums/SampleEnum.md | 36 -- .../markdown/docs/samplegroup/SampleClass.md | 170 ---------- .../Contact/fields/PhotoUrl__c.field-meta.xml | 9 + .../objects/Event__c/Event__c.object-meta.xml | 167 ++++++++++ .../fields/Description__c.field-meta.xml | 10 + .../fields/End_Date__c.field-meta.xml | 9 + .../fields/Location__c.field-meta.xml | 11 + .../fields/Start_Date__c.field-meta.xml | 9 + .../fields/Tag_Line__c.field-meta.xml | 11 + .../Price_Component__c.object-meta.xml | 169 ++++++++++ .../fields/Description__c.field-meta.xml | 11 + .../fields/Expression__c.field-meta.xml | 12 + .../fields/Percent__c.field-meta.xml | 13 + .../fields/Price__c.field-meta.xml | 13 + .../fields/Type__c.field-meta.xml | 30 ++ ...Product_Price_Component__c.object-meta.xml | 166 ++++++++++ .../fields/Price_Component__c.field-meta.xml | 14 + .../fields/Product__c.field-meta.xml | 14 + .../Product__c/Product__c.object-meta.xml | 169 ++++++++++ .../fields/Description__c.field-meta.xml | 11 + .../Product__c/fields/Event__c.field-meta.xml | 12 + .../fields/Features__c.field-meta.xml | 10 + .../Sales_Order_Line__c.object-meta.xml | 167 ++++++++++ .../fields/Amount__c.field-meta.xml | 11 + .../fields/Product__c.field-meta.xml | 13 + .../fields/Sales_Order__c.field-meta.xml | 14 + .../Source_Price_Component__c.field-meta.xml | 13 + .../fields/Type__c.field-meta.xml | 26 ++ .../Sales_Order__c.object-meta.xml | 170 ++++++++++ .../Speaker__c/Speaker__c.object-meta.xml | 167 ++++++++++ .../Speaker__c/fields/About__c.field-meta.xml | 10 + .../Speaker__c/fields/Event__c.field-meta.xml | 14 + .../fields/Person__c.field-meta.xml | 14 + package.json | 2 +- src/cli/commands/markdown.ts | 5 +- src/core/shared/types.d.ts | 13 +- 52 files changed, 1823 insertions(+), 883 deletions(-) create mode 100644 examples/markdown/docs/custom-objects/Event__c.md create mode 100644 examples/markdown/docs/custom-objects/Price_Component__c.md create mode 100644 examples/markdown/docs/custom-objects/Product_Price_Component__c.md create mode 100644 examples/markdown/docs/custom-objects/Product__c.md create mode 100644 examples/markdown/docs/custom-objects/Sales_Order_Line__c.md create mode 100644 examples/markdown/docs/custom-objects/Sales_Order__c.md create mode 100644 examples/markdown/docs/custom-objects/Speaker__c.md delete mode 100644 examples/markdown/docs/miscellaneous/BaseClass.md delete mode 100644 examples/markdown/docs/miscellaneous/MultiInheritanceClass.md delete mode 100644 examples/markdown/docs/miscellaneous/ParentInterface.md delete mode 100644 examples/markdown/docs/miscellaneous/ReferencedEnum.md delete mode 100644 examples/markdown/docs/miscellaneous/SampleException.md delete mode 100644 examples/markdown/docs/miscellaneous/SampleInterface.md delete mode 100644 examples/markdown/docs/miscellaneous/Url.md delete mode 100644 examples/markdown/docs/sample-enums/SampleEnum.md delete mode 100644 examples/markdown/docs/samplegroup/SampleClass.md create mode 100644 examples/markdown/force-app/objects/Contact/fields/PhotoUrl__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Event__c/Event__c.object-meta.xml create mode 100644 examples/markdown/force-app/objects/Event__c/fields/Description__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Event__c/fields/End_Date__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Event__c/fields/Location__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Event__c/fields/Start_Date__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Event__c/fields/Tag_Line__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Price_Component__c/Price_Component__c.object-meta.xml create mode 100644 examples/markdown/force-app/objects/Price_Component__c/fields/Description__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Price_Component__c/fields/Expression__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Price_Component__c/fields/Percent__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Price_Component__c/fields/Price__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Price_Component__c/fields/Type__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Product_Price_Component__c/Product_Price_Component__c.object-meta.xml create mode 100644 examples/markdown/force-app/objects/Product_Price_Component__c/fields/Price_Component__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Product_Price_Component__c/fields/Product__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Product__c/Product__c.object-meta.xml create mode 100644 examples/markdown/force-app/objects/Product__c/fields/Description__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Product__c/fields/Event__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Product__c/fields/Features__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Sales_Order_Line__c/Sales_Order_Line__c.object-meta.xml create mode 100644 examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Amount__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Product__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Sales_Order__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Source_Price_Component__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Type__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Sales_Order__c/Sales_Order__c.object-meta.xml create mode 100644 examples/markdown/force-app/objects/Speaker__c/Speaker__c.object-meta.xml create mode 100644 examples/markdown/force-app/objects/Speaker__c/fields/About__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Speaker__c/fields/Event__c.field-meta.xml create mode 100644 examples/markdown/force-app/objects/Speaker__c/fields/Person__c.field-meta.xml diff --git a/README.md b/README.md index 16bbc696..41e9c7c6 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/examples/markdown/docs/custom-objects/Event__c.md b/examples/markdown/docs/custom-objects/Event__c.md new file mode 100644 index 00000000..111bcb28 --- /dev/null +++ b/examples/markdown/docs/custom-objects/Event__c.md @@ -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* \ No newline at end of file diff --git a/examples/markdown/docs/custom-objects/Price_Component__c.md b/examples/markdown/docs/custom-objects/Price_Component__c.md new file mode 100644 index 00000000..e2305371 --- /dev/null +++ b/examples/markdown/docs/custom-objects/Price_Component__c.md @@ -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'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* \ No newline at end of file diff --git a/examples/markdown/docs/custom-objects/Product_Price_Component__c.md b/examples/markdown/docs/custom-objects/Product_Price_Component__c.md new file mode 100644 index 00000000..2417ab7b --- /dev/null +++ b/examples/markdown/docs/custom-objects/Product_Price_Component__c.md @@ -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* \ No newline at end of file diff --git a/examples/markdown/docs/custom-objects/Product__c.md b/examples/markdown/docs/custom-objects/Product__c.md new file mode 100644 index 00000000..795d2ee1 --- /dev/null +++ b/examples/markdown/docs/custom-objects/Product__c.md @@ -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* \ No newline at end of file diff --git a/examples/markdown/docs/custom-objects/Sales_Order_Line__c.md b/examples/markdown/docs/custom-objects/Sales_Order_Line__c.md new file mode 100644 index 00000000..da0fb5bf --- /dev/null +++ b/examples/markdown/docs/custom-objects/Sales_Order_Line__c.md @@ -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* \ No newline at end of file diff --git a/examples/markdown/docs/custom-objects/Sales_Order__c.md b/examples/markdown/docs/custom-objects/Sales_Order__c.md new file mode 100644 index 00000000..68a97269 --- /dev/null +++ b/examples/markdown/docs/custom-objects/Sales_Order__c.md @@ -0,0 +1,6 @@ +# Sales Order + +Custom object for tracking sales orders. + +## API Name +`ns__Sales_Order__c` \ No newline at end of file diff --git a/examples/markdown/docs/custom-objects/Speaker__c.md b/examples/markdown/docs/custom-objects/Speaker__c.md new file mode 100644 index 00000000..30c579b9 --- /dev/null +++ b/examples/markdown/docs/custom-objects/Speaker__c.md @@ -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* \ No newline at end of file diff --git a/examples/markdown/docs/index.md b/examples/markdown/docs/index.md index 2486eaf6..13118cc3 100644 --- a/examples/markdown/docs/index.md +++ b/examples/markdown/docs/index.md @@ -1,109 +1,27 @@ -# Apex Reference Guide +# Reference Guide -## Miscellaneous +## Custom Objects -### [BaseClass](miscellaneous/BaseClass.md) +### [Event__c](custom-objects/Event__c.md) -### [MultiInheritanceClass](miscellaneous/MultiInheritanceClass.md) +Represents an event that people can register for. -### [ParentInterface](miscellaneous/ParentInterface.md) +### [Price_Component__c](custom-objects/Price_Component__c.md) -### [ReferencedEnum](miscellaneous/ReferencedEnum.md) +### [Product_Price_Component__c](custom-objects/Product_Price_Component__c.md) -### [SampleException](miscellaneous/SampleException.md) +### [Product__c](custom-objects/Product__c.md) -This is a sample exception. +Product that is sold or available for sale. -### [SampleInterface](miscellaneous/SampleInterface.md) +### [Sales_Order_Line__c](custom-objects/Sales_Order_Line__c.md) -This is a sample interface +Represents a line item on a sales order. -### [Url](miscellaneous/Url.md) +### [Sales_Order__c](custom-objects/Sales_Order__c.md) -Represents a uniform resource locator (URL) and provides access to parts of the URL. -Enables access to the base URL used to access your Salesforce org. - -## Usage -Use the methods of the `System.URL` class to create links to objects in your organization. Such objects can be files, images, -logos, or records that you want to include in external emails, in activities, or in Chatter posts. For example, you can create -a link to a file uploaded as an attachment to a Chatter post by concatenating the Salesforce base URL with the file ID: - -```apex -// Get a file uploaded through Chatter. -ContentDocument doc = [SELECT Id FROM ContentDocument - WHERE Title = 'myfile']; -// Create a link to the file. -String fullFileURL = URL.getOrgDomainURL().toExternalForm() + -'/' + doc.id; -system.debug(fullFileURL); -``` +Custom object for tracking sales orders. - -The following example creates a link to a Salesforce record. The full URL is created by concatenating the Salesforce base -URL with the record ID. - -```ape -Account acct = [SELECT Id FROM Account WHERE Name = 'Acme' LIMIT 1]; -String fullRecordURL = URL.getOrgDomainURL().toExternalForm() + '/' + acct.Id; -``` +### [Speaker__c](custom-objects/Speaker__c.md) - -## Example -In this example, the base URL and the full request URL of the current Salesforce server instance are retrieved. Next, a URL -pointing to a specific account object is created. Finally, components of the base and full URL are obtained. This example -prints out all the results to the debug log output. - -```apex -// Create a new account called Acme that we will create a link for later. -Account myAccount = new Account(Name='Acme'); -insert myAccount; - -// Get the base URL. -String sfdcBaseURL = URL.getOrgDomainURL().toExternalForm(); -System.debug('Base URL: ' + sfdcBaseURL ); - -// Get the URL for the current request. -String currentRequestURL = URL.getCurrentRequestUrl().toExternalForm(); -System.debug('Current request URL: ' + currentRequestURL); - -// Create the account URL from the base URL. -String accountURL = URL.getOrgDomainURL().toExternalForm() + - '/' + myAccount.Id; -System.debug('URL of a particular account: ' + accountURL); - -// Get some parts of the base URL. -System.debug('Host: ' + URL.getOrgDomainURL().getHost()); -System.debug('Protocol: ' + URL.getOrgDomainURL().getProtocol()); - -// Get the query string of the current request. -System.debug('Query: ' + URL.getCurrentRequestUrl().getQuery()); -``` - - -## Version Behavior Changes -In API version 41.0 and later, Apex URL objects are represented by the java.net.URI type, not the java.net.URL type. -The API version in which the URL object was instantiated determines the behavior of subsequent method calls to the -specific instance. Salesforce strongly encourages you to use API 41.0 and later versions for fully RFC-compliant URL -parsing that includes proper handling of edge cases of complex URL structures. API 41.0 and later versions also enforce -that inputs are valid, RFC-compliant URL or URI strings. - -* [URL Constructors](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_constructors) -* [URL Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_methods) - -**See Also** -* [URL Class](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_url.htm) - -## Sample Enums - -### [SampleEnum](sample-enums/SampleEnum.md) - -This is a sample enum. This references [ReferencedEnum](miscellaneous/ReferencedEnum.md) . - -This description has several lines - -## SampleGroup - -### [SampleClass](samplegroup/SampleClass.md) - -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. \ No newline at end of file +Represents a speaker at an event. \ No newline at end of file diff --git a/examples/markdown/docs/miscellaneous/BaseClass.md b/examples/markdown/docs/miscellaneous/BaseClass.md deleted file mode 100644 index cffee109..00000000 --- a/examples/markdown/docs/miscellaneous/BaseClass.md +++ /dev/null @@ -1,16 +0,0 @@ -# BaseClass Class -`abstract` - -## Namespace -ns - -## Fields -### `sampleEnumFromBase` - -#### Signature -```apex -public sampleEnumFromBase -``` - -#### Type -[SampleEnum](../sample-enums/SampleEnum.md) \ No newline at end of file diff --git a/examples/markdown/docs/miscellaneous/MultiInheritanceClass.md b/examples/markdown/docs/miscellaneous/MultiInheritanceClass.md deleted file mode 100644 index 4a3f575e..00000000 --- a/examples/markdown/docs/miscellaneous/MultiInheritanceClass.md +++ /dev/null @@ -1,72 +0,0 @@ -# MultiInheritanceClass Class - -## Namespace -ns - -**Inheritance** - -[SampleClass](../samplegroup/SampleClass.md) < [BaseClass](BaseClass.md) - -## Fields -### `sampleEnumFromBase` - -*Inherited* - -#### Signature -```apex -public sampleEnumFromBase -``` - -#### Type -[SampleEnum](../sample-enums/SampleEnum.md) - -## Properties -### Group Name -#### `someProperty` - -*Inherited* - -##### Signature -```apex -public someProperty -``` - -##### Type -String - -## Methods -### Available Methods -#### `doSomething()` - -*Inherited* - -##### Signature -```apex -public void doSomething() -``` - -##### Return Type -**void** - -### Deprecated Methods -#### `sayHello()` - -*Inherited* - -`DEPRECATED` - -This is a sample method. - -##### Signature -```apex -public virtual String sayHello() -``` - -##### Return Type -**String** - -A string value. - -##### Example -SampleClass sample = new SampleClass(); -sample.doSomething(); \ No newline at end of file diff --git a/examples/markdown/docs/miscellaneous/ParentInterface.md b/examples/markdown/docs/miscellaneous/ParentInterface.md deleted file mode 100644 index 879c11e3..00000000 --- a/examples/markdown/docs/miscellaneous/ParentInterface.md +++ /dev/null @@ -1,15 +0,0 @@ -# ParentInterface Interface - -## Namespace -ns - -## Methods -### `sampleParentMethod()` - -#### Signature -```apex -public void sampleParentMethod() -``` - -#### Return Type -**void** \ No newline at end of file diff --git a/examples/markdown/docs/miscellaneous/ReferencedEnum.md b/examples/markdown/docs/miscellaneous/ReferencedEnum.md deleted file mode 100644 index ca1042c3..00000000 --- a/examples/markdown/docs/miscellaneous/ReferencedEnum.md +++ /dev/null @@ -1,8 +0,0 @@ -# ReferencedEnum Enum - -## Namespace -ns - -## Values -| Value | Description | -|-------|-------------| \ No newline at end of file diff --git a/examples/markdown/docs/miscellaneous/SampleException.md b/examples/markdown/docs/miscellaneous/SampleException.md deleted file mode 100644 index 3be0f0d6..00000000 --- a/examples/markdown/docs/miscellaneous/SampleException.md +++ /dev/null @@ -1,24 +0,0 @@ -# SampleException Class - -This is a sample exception. - -**Usage** - -You can use the exception the following way. -You can also take a look at [SampleClass](../samplegroup/SampleClass.md) to see how it is used. -This is a dangerous HTML tag: <script>alert('Hello');</script> - -```apex -try { - throw new SampleException(); -} catch (SampleException e) { - System.debug('Caught exception'); -} -``` - -## Namespace -ns - -**Inheritance** - -Exception \ No newline at end of file diff --git a/examples/markdown/docs/miscellaneous/SampleInterface.md b/examples/markdown/docs/miscellaneous/SampleInterface.md deleted file mode 100644 index cd526e08..00000000 --- a/examples/markdown/docs/miscellaneous/SampleInterface.md +++ /dev/null @@ -1,116 +0,0 @@ -# SampleInterface Interface - -`NAMESPACEACCESSIBLE` - -This is a sample interface - -**Mermaid** - -```mermaid -graph TD - A[SampleInterface] -->|extends| B[ParentInterface] - B -->|extends| C[GrandParentInterface] - C -->|extends| D[GreatGrandParentInterface] -``` - -**Author** John Doe - -**Date** 2020-01-01 - -**See** [SampleEnum](../sample-enums/SampleEnum.md) - -**See** [ReferencedEnum](ReferencedEnum.md) - -## Namespace -ns - -## Example -```apex -SampleInterface sampleInterface = new SampleInterface(); -sampleInterface.sampleMethod(); -``` - -**Extends** -[ParentInterface](ParentInterface.md) - -## Methods -### `sampleMethod()` - -`NAMESPACEACCESSIBLE` - -This is a sample method - -**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] - -#### Signature -```apex -public String sampleMethod() -``` - -#### Return Type -**String** - -Some return value - -#### Throws -[SampleException](SampleException.md): This is a sample exception - -AnotherSampleException: This is another sample exception - -#### Example -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 | [SampleEnum](../sample-enums/SampleEnum.md) | This is an enum parameter | - -#### Return Type -**[SampleEnum](../sample-enums/SampleEnum.md)** - -Some return value - ---- - -### `sampleParentMethod()` - -*Inherited* - -#### Signature -```apex -public void sampleParentMethod() -``` - -#### Return Type -**void** \ No newline at end of file diff --git a/examples/markdown/docs/miscellaneous/Url.md b/examples/markdown/docs/miscellaneous/Url.md deleted file mode 100644 index 4c97b302..00000000 --- a/examples/markdown/docs/miscellaneous/Url.md +++ /dev/null @@ -1,311 +0,0 @@ -# Url Class - -Represents a uniform resource locator (URL) and provides access to parts of the URL. -Enables access to the base URL used to access your Salesforce org. - -## Usage -Use the methods of the `System.URL` class to create links to objects in your organization. Such objects can be files, images, -logos, or records that you want to include in external emails, in activities, or in Chatter posts. For example, you can create -a link to a file uploaded as an attachment to a Chatter post by concatenating the Salesforce base URL with the file ID: - -```apex -// Get a file uploaded through Chatter. -ContentDocument doc = [SELECT Id FROM ContentDocument - WHERE Title = 'myfile']; -// Create a link to the file. -String fullFileURL = URL.getOrgDomainURL().toExternalForm() + -'/' + doc.id; -system.debug(fullFileURL); -``` - - -The following example creates a link to a Salesforce record. The full URL is created by concatenating the Salesforce base -URL with the record ID. - -```ape -Account acct = [SELECT Id FROM Account WHERE Name = 'Acme' LIMIT 1]; -String fullRecordURL = URL.getOrgDomainURL().toExternalForm() + '/' + acct.Id; -``` - - -## Example -In this example, the base URL and the full request URL of the current Salesforce server instance are retrieved. Next, a URL -pointing to a specific account object is created. Finally, components of the base and full URL are obtained. This example -prints out all the results to the debug log output. - -```apex -// Create a new account called Acme that we will create a link for later. -Account myAccount = new Account(Name='Acme'); -insert myAccount; - -// Get the base URL. -String sfdcBaseURL = URL.getOrgDomainURL().toExternalForm(); -System.debug('Base URL: ' + sfdcBaseURL ); - -// Get the URL for the current request. -String currentRequestURL = URL.getCurrentRequestUrl().toExternalForm(); -System.debug('Current request URL: ' + currentRequestURL); - -// Create the account URL from the base URL. -String accountURL = URL.getOrgDomainURL().toExternalForm() + - '/' + myAccount.Id; -System.debug('URL of a particular account: ' + accountURL); - -// Get some parts of the base URL. -System.debug('Host: ' + URL.getOrgDomainURL().getHost()); -System.debug('Protocol: ' + URL.getOrgDomainURL().getProtocol()); - -// Get the query string of the current request. -System.debug('Query: ' + URL.getCurrentRequestUrl().getQuery()); -``` - - -## Version Behavior Changes -In API version 41.0 and later, Apex URL objects are represented by the java.net.URI type, not the java.net.URL type. -The API version in which the URL object was instantiated determines the behavior of subsequent method calls to the -specific instance. Salesforce strongly encourages you to use API 41.0 and later versions for fully RFC-compliant URL -parsing that includes proper handling of edge cases of complex URL structures. API 41.0 and later versions also enforce -that inputs are valid, RFC-compliant URL or URI strings. - -* [URL Constructors](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_constructors) -* [URL Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_methods) - -**See Also** -* [URL Class](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_url.htm) - -## Namespace -ns - -## Constructors -### `Url(spec)` - -Creates a new instance of the URL class using the specified string representation of the URL. - -#### Signature -```apex -global Url(String spec) -``` - -#### Parameters -| Name | Type | Description | -|------|------|-------------| -| spec | String | The string to parse as a URL. | - ---- - -### `Url(context, spec)` - -Creates a new instance of the URL class by parsing the specified spec within the specified context. - -**Usage** - -The new URL is created from the given context URL and the spec argument as described in RFC2396 "Uniform Resource Identifiers : Generic * Syntax" : -```xml -://?# -``` - - -For more information about the arguments of this constructor, see the corresponding URL(java.net.URL, java.lang.String) constructor for Java. - -#### Signature -```apex -global Url(Url context, String spec) -``` - -#### Parameters -| Name | Type | Description | -|------|------|-------------| -| context | [Url](Url.md) | The context in which to parse the specification. | -| spec | String | The string to parse as a URL. | - ---- - -### `Url(protocol, host, file)` - -Creates a new instance of the URL class using the specified protocol, host, and file on the host. The default port for the specified protocol is used. - -#### Signature -```apex -global Url(String protocol, String host, String file) -``` - -#### Parameters -| Name | Type | Description | -|------|------|-------------| -| protocol | String | The protocol name for this URL. | -| host | String | The host name for this URL. | -| file | String | The file name for this URL. | - ---- - -### `Url(protocol, host, port, file)` - -Creates a new instance of the URL class using the specified protocol, host, port number, and file on the host. - -#### Signature -```apex -global Url(String protocol, String host, Integer port, String file) -``` - -#### Parameters -| Name | Type | Description | -|------|------|-------------| -| protocol | String | The protocol name for this URL. | -| host | String | The host name for this URL. | -| port | Integer | The port number for this URL. | -| file | String | The file name for this URL. | - -## Methods -### `getAuthority()` - -Returns the authority portion of the current URL. - -#### Signature -```apex -global String getAuthority() -``` - -#### Return Type -**String** - -The authority portion of the current URL. - ---- - -### `getCurrentRequestUrl()` - -Returns the URL of an entire request on a Salesforce instance. - -**Usage** - -An example of a URL for an entire request is https://yourInstance.salesforce.com/apex/myVfPage.apexp. - -#### Signature -```apex -global static Url getCurrentRequestUrl() -``` - -#### Return Type -**[Url](Url.md)** - -The URL of the entire request. - ---- - -### `getDefPort()` - -Returns the default port number of the protocol associated with the current URL. - -**Usage** - -Returns -1 if the URL scheme or the stream protocol handler for the URL doesn't define a default port number. - -#### Signature -```apex -global Integer getDefPort() -``` - -#### Return Type -**Integer** - -The default port number of the protocol associated with the current URL. - ---- - -### `getFile()` - -Returns the file name of the current URL. - -#### Signature -```apex -global String getFile() -``` - -#### Return Type -**String** - -The file name of the current URL. - ---- - -### `getFileFieldURL(entityId, fieldName)` - -Returns the download URL for a file attachment. - -#### Signature -```apex -global static String getFileFieldURL(String entityId, String fieldName) -``` - -#### Parameters -| Name | Type | Description | -|------|------|-------------| -| entityId | String | Specifies the ID of the entity that holds the file data. | -| fieldName | String | Specifies the API name of a file field component, such as `AttachmentBody` . | - -#### Return Type -**String** - -The download URL for the file attachment. - -#### Example -String fileURL = -URL.getFileFieldURL( -'087000000000123' , -'AttachmentBody'); - ---- - -### `getHost()` - -Returns the host name of the current URL. - -#### Signature -```apex -global String getHost() -``` - -#### Return Type -**String** - -The host name of the current URL. - ---- - -### `getOrgDomainUrl()` - -Returns the canonical URL for your org. For example, https://MyDomainName.my.salesforce.com. - -**Usage** - -Use getOrgDomainUrl() to interact with Salesforce REST and SOAP APIs in Apex code. Get endpoints for User Interface API calls, for creating and customizing picklist value sets and custom fields, and more. - - `getOrgDomainUrl()` can access the domain URL only for the org in which the Apex code is running. - -You don't need a RemoteSiteSetting for your org to interact with the Salesforce APIs using domain URLs retrieved with this method. - -**See Also** - -* [Lightning Aura Components Developer Guide: Making API Calls from Apex](https://developer.salesforce.com/docs/atlas.en-us.250.0.lightning.meta/lightning/apex_api_calls.htm) - -#### Signature -```apex -global static Url getOrgDomainUrl() -``` - -#### Return Type -**[Url](Url.md)** - -getOrgDomainUrl() always returns the login URL for your org, regardless of context. Use that URL when making API calls to your org. - -#### Example -This example uses the Salesforce REST API to get organization limit values. For information on limits, see Limits in the REST API Developer Guide. -```apex -Http h = new Http(); -HttpRequest req = new HttpRequest(); -req.setEndpoint(Url.getOrgDomainUrl().toExternalForm() - + '/services/data/v44.0/limits'); -req.setMethod('GET'); -req.setHeader('Authorization', 'Bearer ' + UserInfo.getSessionId()); -HttpResponse res = h.send(req); -``` \ No newline at end of file diff --git a/examples/markdown/docs/sample-enums/SampleEnum.md b/examples/markdown/docs/sample-enums/SampleEnum.md deleted file mode 100644 index c82b92a0..00000000 --- a/examples/markdown/docs/sample-enums/SampleEnum.md +++ /dev/null @@ -1,36 +0,0 @@ -# SampleEnum Enum - -`NAMESPACEACCESSIBLE` - -This is a sample enum. This references [ReferencedEnum](../miscellaneous/ReferencedEnum.md) . - -This description has several lines - -**Some Custom** - -Test. I can also have a [ReferencedEnum](../miscellaneous/ReferencedEnum.md) here. -And it can be multiline. - -**Mermaid** - -graph TD -A[SampleEnum] -->|references| B[ReferencedEnum] -B -->|referenced by| A - -**Group** Sample Enums - -**Author** John Doe - -**Date** 2022-01-01 - -**See** [ReferencedEnum](../miscellaneous/ReferencedEnum.md) - -## Namespace -ns - -## Values -| Value | Description | -|-------|-------------| -| VALUE1 | This is value 1 | -| VALUE2 | This is value 2 | -| VALUE3 | This is value 3 | \ No newline at end of file diff --git a/examples/markdown/docs/samplegroup/SampleClass.md b/examples/markdown/docs/samplegroup/SampleClass.md deleted file mode 100644 index bda3f37f..00000000 --- a/examples/markdown/docs/samplegroup/SampleClass.md +++ /dev/null @@ -1,170 +0,0 @@ -# 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 -SampleClass sample = new SampleClass(); -sample.doSomething(); - -**Inheritance** - -[BaseClass](../miscellaneous/BaseClass.md) - -**Implements** - -[SampleInterface](../miscellaneous/SampleInterface.md), -[ParentInterface](../miscellaneous/ParentInterface.md) - -## Fields -### Group Name -#### `name` - -This is a sample field. - -##### Signature -```apex -private final name -``` - -##### Type -String - -### Other -#### `sampleEnumFromBase` - -*Inherited* - -##### Signature -```apex -public sampleEnumFromBase -``` - -##### Type -[SampleEnum](../sample-enums/SampleEnum.md) - -## Properties -### Group Name -#### `someProperty` - -##### Signature -```apex -public someProperty -``` - -##### Type -String - -## Constructors -### Other -#### `SampleClass()` - -This is a sample constructor. - -##### Signature -```apex -public SampleClass() -``` - -### Other Constructors -#### `SampleClass(name)` - -##### Signature -```apex -public SampleClass(String name) -``` - -##### Parameters -| Name | Type | Description | -|------|------|-------------| -| name | String | | - -## Methods -### Available Methods -#### `doSomething()` - -##### Signature -```apex -public void doSomething() -``` - -##### Return Type -**void** - -### Deprecated Methods -#### `sayHello()` - -`DEPRECATED` - -This is a sample method. - -##### Signature -```apex -public virtual String sayHello() -``` - -##### Return Type -**String** - -A string value. - -##### Example -SampleClass sample = new SampleClass(); -sample.doSomething(); - -## Classes -### SomeInnerClass Class - -#### Fields -##### `someInnerField` - -###### Signature -```apex -public someInnerField -``` - -###### Type -String - -#### Methods -##### `doSomething()` - -###### Signature -```apex -public void doSomething() -``` - -###### Return Type -**void** - -## Enums -### SomeEnum Enum - -This enum is used for foo and bar. - -#### Values -| Value | Description | -|-------|-------------| -| TEST_1 | This is a test. | -| TEST_2 | | -| TEST_3 | | - -## Interfaces -### SomeInterface Interface - -#### Methods -##### `doSomething()` - -###### Signature -```apex -public void doSomething() -``` - -###### Return Type -**void** \ No newline at end of file diff --git a/examples/markdown/force-app/objects/Contact/fields/PhotoUrl__c.field-meta.xml b/examples/markdown/force-app/objects/Contact/fields/PhotoUrl__c.field-meta.xml new file mode 100644 index 00000000..a9117781 --- /dev/null +++ b/examples/markdown/force-app/objects/Contact/fields/PhotoUrl__c.field-meta.xml @@ -0,0 +1,9 @@ + + + PhotoUrl__c + false + + false + false + Url + diff --git a/examples/markdown/force-app/objects/Event__c/Event__c.object-meta.xml b/examples/markdown/force-app/objects/Event__c/Event__c.object-meta.xml new file mode 100644 index 00000000..d30dde5c --- /dev/null +++ b/examples/markdown/force-app/objects/Event__c/Event__c.object-meta.xml @@ -0,0 +1,167 @@ + + + + Accept + Default + + + Accept + Large + Default + + + Accept + Small + Default + + + CancelEdit + Default + + + CancelEdit + Large + Default + + + CancelEdit + Small + Default + + + Clone + Default + + + Clone + Large + Default + + + Clone + Small + Default + + + Delete + Default + + + Delete + Large + Default + + + Delete + Small + Default + + + Edit + Default + + + Edit + Large + Default + + + Edit + Small + Default + + + List + Default + + + List + Large + Default + + + List + Small + Default + + + New + Default + + + New + Large + Default + + + New + Small + Default + + + SaveEdit + Default + + + SaveEdit + Large + Default + + + SaveEdit + Small + Default + + + Tab + Default + + + Tab + Large + Default + + + Tab + Small + Default + + + View + Default + + + View + Large + Default + + + View + Small + Default + + false + SYSTEM + Deployed + false + true + false + false + false + false + false + true + true + Private + + + + Text + + Events + Represents an event that people can register for. + + ReadWrite + Vowel + Public + diff --git a/examples/markdown/force-app/objects/Event__c/fields/Description__c.field-meta.xml b/examples/markdown/force-app/objects/Event__c/fields/Description__c.field-meta.xml new file mode 100644 index 00000000..c1b682a4 --- /dev/null +++ b/examples/markdown/force-app/objects/Event__c/fields/Description__c.field-meta.xml @@ -0,0 +1,10 @@ + + + Description__c + false + + 32768 + false + LongTextArea + 10 + diff --git a/examples/markdown/force-app/objects/Event__c/fields/End_Date__c.field-meta.xml b/examples/markdown/force-app/objects/Event__c/fields/End_Date__c.field-meta.xml new file mode 100644 index 00000000..422a0003 --- /dev/null +++ b/examples/markdown/force-app/objects/Event__c/fields/End_Date__c.field-meta.xml @@ -0,0 +1,9 @@ + + + End_Date__c + false + + true + false + Date + diff --git a/examples/markdown/force-app/objects/Event__c/fields/Location__c.field-meta.xml b/examples/markdown/force-app/objects/Event__c/fields/Location__c.field-meta.xml new file mode 100644 index 00000000..b8f32121 --- /dev/null +++ b/examples/markdown/force-app/objects/Event__c/fields/Location__c.field-meta.xml @@ -0,0 +1,11 @@ + + + Location__c + false + false + + true + 3 + false + Location + diff --git a/examples/markdown/force-app/objects/Event__c/fields/Start_Date__c.field-meta.xml b/examples/markdown/force-app/objects/Event__c/fields/Start_Date__c.field-meta.xml new file mode 100644 index 00000000..81fb3f6d --- /dev/null +++ b/examples/markdown/force-app/objects/Event__c/fields/Start_Date__c.field-meta.xml @@ -0,0 +1,9 @@ + + + Start_Date__c + false + + true + false + Date + diff --git a/examples/markdown/force-app/objects/Event__c/fields/Tag_Line__c.field-meta.xml b/examples/markdown/force-app/objects/Event__c/fields/Tag_Line__c.field-meta.xml new file mode 100644 index 00000000..652ee2e0 --- /dev/null +++ b/examples/markdown/force-app/objects/Event__c/fields/Tag_Line__c.field-meta.xml @@ -0,0 +1,11 @@ + + + Tag_Line__c + false + + 255 + false + false + Text + false + diff --git a/examples/markdown/force-app/objects/Price_Component__c/Price_Component__c.object-meta.xml b/examples/markdown/force-app/objects/Price_Component__c/Price_Component__c.object-meta.xml new file mode 100644 index 00000000..ae72fd0c --- /dev/null +++ b/examples/markdown/force-app/objects/Price_Component__c/Price_Component__c.object-meta.xml @@ -0,0 +1,169 @@ + + + + Accept + Default + + + Accept + Large + Default + + + Accept + Small + Default + + + CancelEdit + Default + + + CancelEdit + Large + Default + + + CancelEdit + Small + Default + + + Clone + Default + + + Clone + Large + Default + + + Clone + Small + Default + + + Delete + Default + + + Delete + Large + Default + + + Delete + Small + Default + + + Edit + Default + + + Edit + Large + Default + + + Edit + Small + Default + + + List + Default + + + List + Large + Default + + + List + Small + Default + + + New + Default + + + New + Large + Default + + + New + Small + Default + + + SaveEdit + Default + + + SaveEdit + Large + Default + + + SaveEdit + Small + Default + + + Tab + Default + + + Tab + Large + Default + + + Tab + Small + Default + + + View + Action override created by Lightning App Builder during activation. + Price_Component_Record_Page + Large + false + Flexipage + + + View + Default + + + View + Small + Default + + false + SYSTEM + Deployed + false + true + false + false + false + false + false + true + true + Private + + + PC-{0000} + + AutoNumber + + Price Components + + ReadWrite + Public + diff --git a/examples/markdown/force-app/objects/Price_Component__c/fields/Description__c.field-meta.xml b/examples/markdown/force-app/objects/Price_Component__c/fields/Description__c.field-meta.xml new file mode 100644 index 00000000..69050ca6 --- /dev/null +++ b/examples/markdown/force-app/objects/Price_Component__c/fields/Description__c.field-meta.xml @@ -0,0 +1,11 @@ + + + Description__c + false + + 255 + false + false + Text + false + diff --git a/examples/markdown/force-app/objects/Price_Component__c/fields/Expression__c.field-meta.xml b/examples/markdown/force-app/objects/Price_Component__c/fields/Expression__c.field-meta.xml new file mode 100644 index 00000000..c0bf4e45 --- /dev/null +++ b/examples/markdown/force-app/objects/Price_Component__c/fields/Expression__c.field-meta.xml @@ -0,0 +1,12 @@ + + + Expression__c + The Expression that determines if this price should take effect or not. + false + The Expression that determines if this price should take effect or not. + + 131072 + false + LongTextArea + 20 + diff --git a/examples/markdown/force-app/objects/Price_Component__c/fields/Percent__c.field-meta.xml b/examples/markdown/force-app/objects/Price_Component__c/fields/Percent__c.field-meta.xml new file mode 100644 index 00000000..9c303bc4 --- /dev/null +++ b/examples/markdown/force-app/objects/Price_Component__c/fields/Percent__c.field-meta.xml @@ -0,0 +1,13 @@ + + + Percent__c + Use this field to calculate the price based on the list price's percentage instead of providing a flat price. + false + Use this field to calculate the price based on the list price's percentage instead of providing a flat price. + + 18 + false + 0 + false + Percent + diff --git a/examples/markdown/force-app/objects/Price_Component__c/fields/Price__c.field-meta.xml b/examples/markdown/force-app/objects/Price_Component__c/fields/Price__c.field-meta.xml new file mode 100644 index 00000000..84136dec --- /dev/null +++ b/examples/markdown/force-app/objects/Price_Component__c/fields/Price__c.field-meta.xml @@ -0,0 +1,13 @@ + + + Price__c + Use this when the Price Component represents a Flat Price. To represent a Percentage use the Percent field. + false + Use this when the Price Component represents a Flat Price. To represent a Percentage use the Percent field. + + 18 + false + 2 + false + Currency + diff --git a/examples/markdown/force-app/objects/Price_Component__c/fields/Type__c.field-meta.xml b/examples/markdown/force-app/objects/Price_Component__c/fields/Type__c.field-meta.xml new file mode 100644 index 00000000..c430b305 --- /dev/null +++ b/examples/markdown/force-app/objects/Price_Component__c/fields/Type__c.field-meta.xml @@ -0,0 +1,30 @@ + + + Type__c + false + + true + false + Picklist + + true + + false + + List Price + false + + + + Surcharge + false + + + + Discount + false + + + + + diff --git a/examples/markdown/force-app/objects/Product_Price_Component__c/Product_Price_Component__c.object-meta.xml b/examples/markdown/force-app/objects/Product_Price_Component__c/Product_Price_Component__c.object-meta.xml new file mode 100644 index 00000000..8a9a6348 --- /dev/null +++ b/examples/markdown/force-app/objects/Product_Price_Component__c/Product_Price_Component__c.object-meta.xml @@ -0,0 +1,166 @@ + + + + Accept + Default + + + Accept + Large + Default + + + Accept + Small + Default + + + CancelEdit + Default + + + CancelEdit + Large + Default + + + CancelEdit + Small + Default + + + Clone + Default + + + Clone + Large + Default + + + Clone + Small + Default + + + Delete + Default + + + Delete + Large + Default + + + Delete + Small + Default + + + Edit + Default + + + Edit + Large + Default + + + Edit + Small + Default + + + List + Default + + + List + Large + Default + + + List + Small + Default + + + New + Default + + + New + Large + Default + + + New + Small + Default + + + SaveEdit + Default + + + SaveEdit + Large + Default + + + SaveEdit + Small + Default + + + Tab + Default + + + Tab + Large + Default + + + Tab + Small + Default + + + View + Default + + + View + Large + Default + + + View + Small + Default + + false + SYSTEM + Deployed + false + true + false + false + false + false + false + true + true + ControlledByParent + + + PPC-{0000} + + AutoNumber + + Product Price Components + + ControlledByParent + Public + diff --git a/examples/markdown/force-app/objects/Product_Price_Component__c/fields/Price_Component__c.field-meta.xml b/examples/markdown/force-app/objects/Product_Price_Component__c/fields/Price_Component__c.field-meta.xml new file mode 100644 index 00000000..f152ecb6 --- /dev/null +++ b/examples/markdown/force-app/objects/Product_Price_Component__c/fields/Price_Component__c.field-meta.xml @@ -0,0 +1,14 @@ + + + Price_Component__c + false + + Price_Component__c + Product Price Components + Product_Price_Components + 1 + false + false + MasterDetail + false + diff --git a/examples/markdown/force-app/objects/Product_Price_Component__c/fields/Product__c.field-meta.xml b/examples/markdown/force-app/objects/Product_Price_Component__c/fields/Product__c.field-meta.xml new file mode 100644 index 00000000..16ec5b33 --- /dev/null +++ b/examples/markdown/force-app/objects/Product_Price_Component__c/fields/Product__c.field-meta.xml @@ -0,0 +1,14 @@ + + + Product__c + false + + Product__c + Product Price Components + Product_Price_Components + 0 + false + false + MasterDetail + false + diff --git a/examples/markdown/force-app/objects/Product__c/Product__c.object-meta.xml b/examples/markdown/force-app/objects/Product__c/Product__c.object-meta.xml new file mode 100644 index 00000000..cdeb52a9 --- /dev/null +++ b/examples/markdown/force-app/objects/Product__c/Product__c.object-meta.xml @@ -0,0 +1,169 @@ + + + + Accept + Default + + + Accept + Large + Default + + + Accept + Small + Default + + + CancelEdit + Default + + + CancelEdit + Large + Default + + + CancelEdit + Small + Default + + + Clone + Default + + + Clone + Large + Default + + + Clone + Small + Default + + + Delete + Default + + + Delete + Large + Default + + + Delete + Small + Default + + + Edit + Default + + + Edit + Large + Default + + + Edit + Small + Default + + + List + Default + + + List + Large + Default + + + List + Small + Default + + + New + Default + + + New + Large + Default + + + New + Small + Default + + + SaveEdit + Default + + + SaveEdit + Large + Default + + + SaveEdit + Small + Default + + + Tab + Default + + + Tab + Large + Default + + + Tab + Small + Default + + + View + Action override created by Lightning App Builder during activation. + Product_Record_Page + Large + false + Flexipage + + + View + Default + + + View + Small + Default + + false + SYSTEM + Deployed + false + true + false + false + false + false + false + true + true + Private + + Product that is sold or available for sale. + + + Text + + Products + + ReadWrite + Public + diff --git a/examples/markdown/force-app/objects/Product__c/fields/Description__c.field-meta.xml b/examples/markdown/force-app/objects/Product__c/fields/Description__c.field-meta.xml new file mode 100644 index 00000000..69050ca6 --- /dev/null +++ b/examples/markdown/force-app/objects/Product__c/fields/Description__c.field-meta.xml @@ -0,0 +1,11 @@ + + + Description__c + false + + 255 + false + false + Text + false + diff --git a/examples/markdown/force-app/objects/Product__c/fields/Event__c.field-meta.xml b/examples/markdown/force-app/objects/Product__c/fields/Event__c.field-meta.xml new file mode 100644 index 00000000..82947d0b --- /dev/null +++ b/examples/markdown/force-app/objects/Product__c/fields/Event__c.field-meta.xml @@ -0,0 +1,12 @@ + + + Event__c + Restrict + false + + Event__c + Products + true + false + Lookup + diff --git a/examples/markdown/force-app/objects/Product__c/fields/Features__c.field-meta.xml b/examples/markdown/force-app/objects/Product__c/fields/Features__c.field-meta.xml new file mode 100644 index 00000000..6b67a859 --- /dev/null +++ b/examples/markdown/force-app/objects/Product__c/fields/Features__c.field-meta.xml @@ -0,0 +1,10 @@ + + + Features__c + false + + 32768 + false + LongTextArea + 10 + diff --git a/examples/markdown/force-app/objects/Sales_Order_Line__c/Sales_Order_Line__c.object-meta.xml b/examples/markdown/force-app/objects/Sales_Order_Line__c/Sales_Order_Line__c.object-meta.xml new file mode 100644 index 00000000..36e9348d --- /dev/null +++ b/examples/markdown/force-app/objects/Sales_Order_Line__c/Sales_Order_Line__c.object-meta.xml @@ -0,0 +1,167 @@ + + + + Accept + Default + + + Accept + Large + Default + + + Accept + Small + Default + + + CancelEdit + Default + + + CancelEdit + Large + Default + + + CancelEdit + Small + Default + + + Clone + Default + + + Clone + Large + Default + + + Clone + Small + Default + + + Delete + Default + + + Delete + Large + Default + + + Delete + Small + Default + + + Edit + Default + + + Edit + Large + Default + + + Edit + Small + Default + + + List + Default + + + List + Large + Default + + + List + Small + Default + + + New + Default + + + New + Large + Default + + + New + Small + Default + + + SaveEdit + Default + + + SaveEdit + Large + Default + + + SaveEdit + Small + Default + + + Tab + Default + + + Tab + Large + Default + + + Tab + Small + Default + + + View + Default + + + View + Large + Default + + + View + Small + Default + + false + SYSTEM + Deployed + false + true + false + false + false + false + false + true + true + ControlledByParent + + Represents a line item on a sales order. + + SOL-{0000} + + AutoNumber + + Sales Order Lines + + ControlledByParent + Public + diff --git a/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Amount__c.field-meta.xml b/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Amount__c.field-meta.xml new file mode 100644 index 00000000..3a464e2d --- /dev/null +++ b/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Amount__c.field-meta.xml @@ -0,0 +1,11 @@ + + + Amount__c + false + + 18 + true + 2 + false + Currency + diff --git a/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Product__c.field-meta.xml b/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Product__c.field-meta.xml new file mode 100644 index 00000000..b6b5369f --- /dev/null +++ b/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Product__c.field-meta.xml @@ -0,0 +1,13 @@ + + + Product__c + Restrict + false + + Product__c + Sales Order Lines + Sales_Order_Lines + true + false + Lookup + diff --git a/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Sales_Order__c.field-meta.xml b/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Sales_Order__c.field-meta.xml new file mode 100644 index 00000000..c1d881c8 --- /dev/null +++ b/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Sales_Order__c.field-meta.xml @@ -0,0 +1,14 @@ + + + Sales_Order__c + false + + Sales_Order__c + Sales Order Lines + Sales_Order_Lines + 0 + false + false + MasterDetail + false + diff --git a/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Source_Price_Component__c.field-meta.xml b/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Source_Price_Component__c.field-meta.xml new file mode 100644 index 00000000..69817d96 --- /dev/null +++ b/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Source_Price_Component__c.field-meta.xml @@ -0,0 +1,13 @@ + + + Source_Price_Component__c + SetNull + false + + Price_Component__c + Sales Order Lines + Sales_Order_Lines + false + false + Lookup + diff --git a/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Type__c.field-meta.xml b/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Type__c.field-meta.xml new file mode 100644 index 00000000..328b5529 --- /dev/null +++ b/examples/markdown/force-app/objects/Sales_Order_Line__c/fields/Type__c.field-meta.xml @@ -0,0 +1,26 @@ + + + Type__c + "Charge" + false + + true + false + Picklist + + true + + false + + Charge + false + + + + Discount + false + + + + + diff --git a/examples/markdown/force-app/objects/Sales_Order__c/Sales_Order__c.object-meta.xml b/examples/markdown/force-app/objects/Sales_Order__c/Sales_Order__c.object-meta.xml new file mode 100644 index 00000000..2225e4f9 --- /dev/null +++ b/examples/markdown/force-app/objects/Sales_Order__c/Sales_Order__c.object-meta.xml @@ -0,0 +1,170 @@ + + + + Accept + Default + + + Accept + Large + Default + + + Accept + Small + Default + + + CancelEdit + Default + + + CancelEdit + Large + Default + + + CancelEdit + Small + Default + + + Clone + Default + + + Clone + Large + Default + + + Clone + Small + Default + + + Delete + Default + + + Delete + Large + Default + + + Delete + Small + Default + + + Edit + Default + + + Edit + Large + Default + + + Edit + Small + Default + + + List + Default + + + List + Large + Default + + + List + Small + Default + + + New + Default + + + New + Large + Default + + + New + Small + Default + + + SaveEdit + Default + + + SaveEdit + Large + Default + + + SaveEdit + Small + Default + + + Tab + Default + + + Tab + Large + Default + + + Tab + Small + Default + + + View + Action override created by Lightning App Builder during activation. + Sales_Order_Record_Page + Large + false + Flexipage + + + View + Default + + + View + Small + Default + + false + SYSTEM + Deployed + false + true + false + false + false + false + false + true + true + Private + + Custom object for tracking sales orders. + + SO-{0000} + + AutoNumber + + Sales Orders + + ReadWrite + Public + diff --git a/examples/markdown/force-app/objects/Speaker__c/Speaker__c.object-meta.xml b/examples/markdown/force-app/objects/Speaker__c/Speaker__c.object-meta.xml new file mode 100644 index 00000000..6bdf2199 --- /dev/null +++ b/examples/markdown/force-app/objects/Speaker__c/Speaker__c.object-meta.xml @@ -0,0 +1,167 @@ + + + + Accept + Default + + + Accept + Large + Default + + + Accept + Small + Default + + + CancelEdit + Default + + + CancelEdit + Large + Default + + + CancelEdit + Small + Default + + + Clone + Default + + + Clone + Large + Default + + + Clone + Small + Default + + + Delete + Default + + + Delete + Large + Default + + + Delete + Small + Default + + + Edit + Default + + + Edit + Large + Default + + + Edit + Small + Default + + + List + Default + + + List + Large + Default + + + List + Small + Default + + + New + Default + + + New + Large + Default + + + New + Small + Default + + + SaveEdit + Default + + + SaveEdit + Large + Default + + + SaveEdit + Small + Default + + + Tab + Default + + + Tab + Large + Default + + + Tab + Small + Default + + + View + Default + + + View + Large + Default + + + View + Small + Default + + false + SYSTEM + Deployed + false + true + false + false + false + false + false + true + true + ControlledByParent + + Represents a speaker at an event. + + SPEAK-{0000} + + AutoNumber + + Speakers + + ControlledByParent + Public + diff --git a/examples/markdown/force-app/objects/Speaker__c/fields/About__c.field-meta.xml b/examples/markdown/force-app/objects/Speaker__c/fields/About__c.field-meta.xml new file mode 100644 index 00000000..2fc71d94 --- /dev/null +++ b/examples/markdown/force-app/objects/Speaker__c/fields/About__c.field-meta.xml @@ -0,0 +1,10 @@ + + + About__c + false + + 32768 + false + LongTextArea + 3 + diff --git a/examples/markdown/force-app/objects/Speaker__c/fields/Event__c.field-meta.xml b/examples/markdown/force-app/objects/Speaker__c/fields/Event__c.field-meta.xml new file mode 100644 index 00000000..cf6bfc63 --- /dev/null +++ b/examples/markdown/force-app/objects/Speaker__c/fields/Event__c.field-meta.xml @@ -0,0 +1,14 @@ + + + Event__c + false + + Event__c + Speakers + Speakers + 0 + false + false + MasterDetail + false + diff --git a/examples/markdown/force-app/objects/Speaker__c/fields/Person__c.field-meta.xml b/examples/markdown/force-app/objects/Speaker__c/fields/Person__c.field-meta.xml new file mode 100644 index 00000000..b7ac07b1 --- /dev/null +++ b/examples/markdown/force-app/objects/Speaker__c/fields/Person__c.field-meta.xml @@ -0,0 +1,14 @@ + + + Person__c + false + + Contact + Speakers + Speakers + 1 + false + false + MasterDetail + false + diff --git a/package.json b/package.json index 3bb7bd76..43b8a745 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@cparra/apexdocs", - "version": "3.4.0", + "version": "3.4.1", "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.", "keywords": [ "apex", diff --git a/src/cli/commands/markdown.ts b/src/cli/commands/markdown.ts index b8531a9f..e029d3b8 100644 --- a/src/cli/commands/markdown.ts +++ b/src/cli/commands/markdown.ts @@ -1,7 +1,8 @@ import { Options } from 'yargs'; import { markdownDefaults } from '../../defaults'; +import { CliConfigurableMarkdownConfig } from '../../core/shared/types'; -export const markdownOptions: { [key: string]: Options } = { +export const markdownOptions: Record = { sourceDir: { type: 'string', alias: 's', @@ -28,7 +29,7 @@ export const markdownOptions: { [key: string]: Options } = { default: markdownDefaults.defaultGroupName, describe: 'Defines the @group name to be used when a file does not specify it.', }, - customObjectGroupName: { + customObjectsGroupName: { type: 'string', default: markdownDefaults.customObjectsGroupName, describe: 'The name under which custom objects will be grouped in the Reference Guide', diff --git a/src/core/shared/types.d.ts b/src/core/shared/types.d.ts index a3c5cac1..2bc75ab1 100644 --- a/src/core/shared/types.d.ts +++ b/src/core/shared/types.d.ts @@ -16,9 +16,8 @@ type LinkingStrategy = // No logic will be applied, the reference path will be used as is. | 'none'; -export type UserDefinedMarkdownConfig = { +export type CliConfigurableMarkdownConfig = { sourceDir: string; - targetGenerator: 'markdown'; targetDir: string; scope: string[]; namespace?: string; @@ -27,11 +26,15 @@ export type UserDefinedMarkdownConfig = { sortAlphabetically: boolean; includeMetadata: boolean; linkingStrategy: LinkingStrategy; - excludeTags: string[]; referenceGuideTitle: string; - /** Glob patterns to exclude files from the documentation. */ +}; + +export type UserDefinedMarkdownConfig = { + targetGenerator: 'markdown' /** Glob patterns to exclude files from the documentation. */; + excludeTags: string[]; exclude: string[]; -} & Partial; +} & CliConfigurableMarkdownConfig & + Partial; export type UserDefinedOpenApiConfig = { targetGenerator: 'openapi'; From 229883c598d9849b643517cf138d4d7db8ef6d13 Mon Sep 17 00:00:00 2001 From: cesarParra Date: Wed, 23 Oct 2024 11:16:45 -0400 Subject: [PATCH 2/3] Fixing typo with CLI configuration name --- .../changelog/current/classes/AccountService.cls-meta.xml | 5 +++++ .../changelog/current/classes/IAnotherExample.cls-meta.xml | 5 +++++ .../changelog/current/classes/IExemplificable.cls-meta.xml | 5 +++++ .../changelog/current/classes/PossibleValues.cls-meta.xml | 5 +++++ examples/changelog/current/classes/SolidService.cls-meta.xml | 5 +++++ examples/changelog/previous/OldImplementation.cls-meta.xml | 5 +++++ examples/changelog/previous/SolidService.cls-meta.xml | 5 +++++ src/cli/args.ts | 2 +- 8 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 examples/changelog/current/classes/AccountService.cls-meta.xml create mode 100644 examples/changelog/current/classes/IAnotherExample.cls-meta.xml create mode 100644 examples/changelog/current/classes/IExemplificable.cls-meta.xml create mode 100644 examples/changelog/current/classes/PossibleValues.cls-meta.xml create mode 100644 examples/changelog/current/classes/SolidService.cls-meta.xml create mode 100644 examples/changelog/previous/OldImplementation.cls-meta.xml create mode 100644 examples/changelog/previous/SolidService.cls-meta.xml diff --git a/examples/changelog/current/classes/AccountService.cls-meta.xml b/examples/changelog/current/classes/AccountService.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/changelog/current/classes/AccountService.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/examples/changelog/current/classes/IAnotherExample.cls-meta.xml b/examples/changelog/current/classes/IAnotherExample.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/changelog/current/classes/IAnotherExample.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/examples/changelog/current/classes/IExemplificable.cls-meta.xml b/examples/changelog/current/classes/IExemplificable.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/changelog/current/classes/IExemplificable.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/examples/changelog/current/classes/PossibleValues.cls-meta.xml b/examples/changelog/current/classes/PossibleValues.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/changelog/current/classes/PossibleValues.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/examples/changelog/current/classes/SolidService.cls-meta.xml b/examples/changelog/current/classes/SolidService.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/changelog/current/classes/SolidService.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/examples/changelog/previous/OldImplementation.cls-meta.xml b/examples/changelog/previous/OldImplementation.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/changelog/previous/OldImplementation.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/examples/changelog/previous/SolidService.cls-meta.xml b/examples/changelog/previous/SolidService.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/changelog/previous/SolidService.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/src/cli/args.ts b/src/cli/args.ts index 9f6cedc5..4a0ff7a7 100644 --- a/src/cli/args.ts +++ b/src/cli/args.ts @@ -142,7 +142,7 @@ function extractArgsForCommandsProvidedInConfig( } }); - return E.sequenceArray(configs); + return E.sequenceArray(configs) as E.Either; } type NoConfig = { From 152145264edadb68570626839017f7e35974098e Mon Sep 17 00:00:00 2001 From: cesarParra Date: Wed, 23 Oct 2024 11:18:43 -0400 Subject: [PATCH 3/3] Fixing typo with CLI configuration name --- examples/markdown/docs/index.md | 110 ++++++- .../markdown/docs/miscellaneous/BaseClass.md | 16 + .../miscellaneous/MultiInheritanceClass.md | 72 ++++ .../docs/miscellaneous/ParentInterface.md | 15 + .../docs/miscellaneous/ReferencedEnum.md | 8 + .../docs/miscellaneous/SampleException.md | 24 ++ .../docs/miscellaneous/SampleInterface.md | 116 +++++++ examples/markdown/docs/miscellaneous/Url.md | 311 ++++++++++++++++++ .../markdown/docs/sample-enums/SampleEnum.md | 36 ++ .../markdown/docs/samplegroup/SampleClass.md | 170 ++++++++++ .../force-app/classes/BaseClass.cls-meta.xml | 5 + .../MultiInheritanceClass.cls-meta.xml | 5 + .../classes/ParentInterface.cls-meta.xml | 5 + .../classes/ReferencedEnum.cls-meta.xml | 5 + .../classes/SampleClass.cls-meta.xml | 5 + .../force-app/classes/SampleEnum.cls-meta.xml | 5 + .../classes/SampleException.cls-meta.xml | 5 + .../classes/SampleInterface.cls-meta.xml | 5 + .../force-app/classes/Url.cls-meta.xml | 5 + 19 files changed, 922 insertions(+), 1 deletion(-) create mode 100644 examples/markdown/docs/miscellaneous/BaseClass.md create mode 100644 examples/markdown/docs/miscellaneous/MultiInheritanceClass.md create mode 100644 examples/markdown/docs/miscellaneous/ParentInterface.md create mode 100644 examples/markdown/docs/miscellaneous/ReferencedEnum.md create mode 100644 examples/markdown/docs/miscellaneous/SampleException.md create mode 100644 examples/markdown/docs/miscellaneous/SampleInterface.md create mode 100644 examples/markdown/docs/miscellaneous/Url.md create mode 100644 examples/markdown/docs/sample-enums/SampleEnum.md create mode 100644 examples/markdown/docs/samplegroup/SampleClass.md create mode 100644 examples/markdown/force-app/classes/BaseClass.cls-meta.xml create mode 100644 examples/markdown/force-app/classes/MultiInheritanceClass.cls-meta.xml create mode 100644 examples/markdown/force-app/classes/ParentInterface.cls-meta.xml create mode 100644 examples/markdown/force-app/classes/ReferencedEnum.cls-meta.xml create mode 100644 examples/markdown/force-app/classes/SampleClass.cls-meta.xml create mode 100644 examples/markdown/force-app/classes/SampleEnum.cls-meta.xml create mode 100644 examples/markdown/force-app/classes/SampleException.cls-meta.xml create mode 100644 examples/markdown/force-app/classes/SampleInterface.cls-meta.xml create mode 100644 examples/markdown/force-app/classes/Url.cls-meta.xml diff --git a/examples/markdown/docs/index.md b/examples/markdown/docs/index.md index 13118cc3..bc012275 100644 --- a/examples/markdown/docs/index.md +++ b/examples/markdown/docs/index.md @@ -24,4 +24,112 @@ Custom object for tracking sales orders. ### [Speaker__c](custom-objects/Speaker__c.md) -Represents a speaker at an event. \ No newline at end of file +Represents a speaker at an event. + +## Miscellaneous + +### [BaseClass](miscellaneous/BaseClass.md) + +### [MultiInheritanceClass](miscellaneous/MultiInheritanceClass.md) + +### [ParentInterface](miscellaneous/ParentInterface.md) + +### [ReferencedEnum](miscellaneous/ReferencedEnum.md) + +### [SampleException](miscellaneous/SampleException.md) + +This is a sample exception. + +### [SampleInterface](miscellaneous/SampleInterface.md) + +This is a sample interface + +### [Url](miscellaneous/Url.md) + +Represents a uniform resource locator (URL) and provides access to parts of the URL. +Enables access to the base URL used to access your Salesforce org. + +## Usage +Use the methods of the `System.URL` class to create links to objects in your organization. Such objects can be files, images, +logos, or records that you want to include in external emails, in activities, or in Chatter posts. For example, you can create +a link to a file uploaded as an attachment to a Chatter post by concatenating the Salesforce base URL with the file ID: + +```apex +// Get a file uploaded through Chatter. +ContentDocument doc = [SELECT Id FROM ContentDocument + WHERE Title = 'myfile']; +// Create a link to the file. +String fullFileURL = URL.getOrgDomainURL().toExternalForm() + +'/' + doc.id; +system.debug(fullFileURL); +``` + + +The following example creates a link to a Salesforce record. The full URL is created by concatenating the Salesforce base +URL with the record ID. + +```ape +Account acct = [SELECT Id FROM Account WHERE Name = 'Acme' LIMIT 1]; +String fullRecordURL = URL.getOrgDomainURL().toExternalForm() + '/' + acct.Id; +``` + + +## Example +In this example, the base URL and the full request URL of the current Salesforce server instance are retrieved. Next, a URL +pointing to a specific account object is created. Finally, components of the base and full URL are obtained. This example +prints out all the results to the debug log output. + +```apex +// Create a new account called Acme that we will create a link for later. +Account myAccount = new Account(Name='Acme'); +insert myAccount; + +// Get the base URL. +String sfdcBaseURL = URL.getOrgDomainURL().toExternalForm(); +System.debug('Base URL: ' + sfdcBaseURL ); + +// Get the URL for the current request. +String currentRequestURL = URL.getCurrentRequestUrl().toExternalForm(); +System.debug('Current request URL: ' + currentRequestURL); + +// Create the account URL from the base URL. +String accountURL = URL.getOrgDomainURL().toExternalForm() + + '/' + myAccount.Id; +System.debug('URL of a particular account: ' + accountURL); + +// Get some parts of the base URL. +System.debug('Host: ' + URL.getOrgDomainURL().getHost()); +System.debug('Protocol: ' + URL.getOrgDomainURL().getProtocol()); + +// Get the query string of the current request. +System.debug('Query: ' + URL.getCurrentRequestUrl().getQuery()); +``` + + +## Version Behavior Changes +In API version 41.0 and later, Apex URL objects are represented by the java.net.URI type, not the java.net.URL type. +The API version in which the URL object was instantiated determines the behavior of subsequent method calls to the +specific instance. Salesforce strongly encourages you to use API 41.0 and later versions for fully RFC-compliant URL +parsing that includes proper handling of edge cases of complex URL structures. API 41.0 and later versions also enforce +that inputs are valid, RFC-compliant URL or URI strings. + +* [URL Constructors](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_constructors) +* [URL Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_methods) + +**See Also** +* [URL Class](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_url.htm) + +## Sample Enums + +### [SampleEnum](sample-enums/SampleEnum.md) + +This is a sample enum. This references [ReferencedEnum](miscellaneous/ReferencedEnum.md) . + +This description has several lines + +## SampleGroup + +### [SampleClass](samplegroup/SampleClass.md) + +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. \ No newline at end of file diff --git a/examples/markdown/docs/miscellaneous/BaseClass.md b/examples/markdown/docs/miscellaneous/BaseClass.md new file mode 100644 index 00000000..cffee109 --- /dev/null +++ b/examples/markdown/docs/miscellaneous/BaseClass.md @@ -0,0 +1,16 @@ +# BaseClass Class +`abstract` + +## Namespace +ns + +## Fields +### `sampleEnumFromBase` + +#### Signature +```apex +public sampleEnumFromBase +``` + +#### Type +[SampleEnum](../sample-enums/SampleEnum.md) \ No newline at end of file diff --git a/examples/markdown/docs/miscellaneous/MultiInheritanceClass.md b/examples/markdown/docs/miscellaneous/MultiInheritanceClass.md new file mode 100644 index 00000000..4a3f575e --- /dev/null +++ b/examples/markdown/docs/miscellaneous/MultiInheritanceClass.md @@ -0,0 +1,72 @@ +# MultiInheritanceClass Class + +## Namespace +ns + +**Inheritance** + +[SampleClass](../samplegroup/SampleClass.md) < [BaseClass](BaseClass.md) + +## Fields +### `sampleEnumFromBase` + +*Inherited* + +#### Signature +```apex +public sampleEnumFromBase +``` + +#### Type +[SampleEnum](../sample-enums/SampleEnum.md) + +## Properties +### Group Name +#### `someProperty` + +*Inherited* + +##### Signature +```apex +public someProperty +``` + +##### Type +String + +## Methods +### Available Methods +#### `doSomething()` + +*Inherited* + +##### Signature +```apex +public void doSomething() +``` + +##### Return Type +**void** + +### Deprecated Methods +#### `sayHello()` + +*Inherited* + +`DEPRECATED` + +This is a sample method. + +##### Signature +```apex +public virtual String sayHello() +``` + +##### Return Type +**String** + +A string value. + +##### Example +SampleClass sample = new SampleClass(); +sample.doSomething(); \ No newline at end of file diff --git a/examples/markdown/docs/miscellaneous/ParentInterface.md b/examples/markdown/docs/miscellaneous/ParentInterface.md new file mode 100644 index 00000000..879c11e3 --- /dev/null +++ b/examples/markdown/docs/miscellaneous/ParentInterface.md @@ -0,0 +1,15 @@ +# ParentInterface Interface + +## Namespace +ns + +## Methods +### `sampleParentMethod()` + +#### Signature +```apex +public void sampleParentMethod() +``` + +#### Return Type +**void** \ No newline at end of file diff --git a/examples/markdown/docs/miscellaneous/ReferencedEnum.md b/examples/markdown/docs/miscellaneous/ReferencedEnum.md new file mode 100644 index 00000000..ca1042c3 --- /dev/null +++ b/examples/markdown/docs/miscellaneous/ReferencedEnum.md @@ -0,0 +1,8 @@ +# ReferencedEnum Enum + +## Namespace +ns + +## Values +| Value | Description | +|-------|-------------| \ No newline at end of file diff --git a/examples/markdown/docs/miscellaneous/SampleException.md b/examples/markdown/docs/miscellaneous/SampleException.md new file mode 100644 index 00000000..3be0f0d6 --- /dev/null +++ b/examples/markdown/docs/miscellaneous/SampleException.md @@ -0,0 +1,24 @@ +# SampleException Class + +This is a sample exception. + +**Usage** + +You can use the exception the following way. +You can also take a look at [SampleClass](../samplegroup/SampleClass.md) to see how it is used. +This is a dangerous HTML tag: <script>alert('Hello');</script> + +```apex +try { + throw new SampleException(); +} catch (SampleException e) { + System.debug('Caught exception'); +} +``` + +## Namespace +ns + +**Inheritance** + +Exception \ No newline at end of file diff --git a/examples/markdown/docs/miscellaneous/SampleInterface.md b/examples/markdown/docs/miscellaneous/SampleInterface.md new file mode 100644 index 00000000..cd526e08 --- /dev/null +++ b/examples/markdown/docs/miscellaneous/SampleInterface.md @@ -0,0 +1,116 @@ +# SampleInterface Interface + +`NAMESPACEACCESSIBLE` + +This is a sample interface + +**Mermaid** + +```mermaid +graph TD + A[SampleInterface] -->|extends| B[ParentInterface] + B -->|extends| C[GrandParentInterface] + C -->|extends| D[GreatGrandParentInterface] +``` + +**Author** John Doe + +**Date** 2020-01-01 + +**See** [SampleEnum](../sample-enums/SampleEnum.md) + +**See** [ReferencedEnum](ReferencedEnum.md) + +## Namespace +ns + +## Example +```apex +SampleInterface sampleInterface = new SampleInterface(); +sampleInterface.sampleMethod(); +``` + +**Extends** +[ParentInterface](ParentInterface.md) + +## Methods +### `sampleMethod()` + +`NAMESPACEACCESSIBLE` + +This is a sample method + +**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] + +#### Signature +```apex +public String sampleMethod() +``` + +#### Return Type +**String** + +Some return value + +#### Throws +[SampleException](SampleException.md): This is a sample exception + +AnotherSampleException: This is another sample exception + +#### Example +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 | [SampleEnum](../sample-enums/SampleEnum.md) | This is an enum parameter | + +#### Return Type +**[SampleEnum](../sample-enums/SampleEnum.md)** + +Some return value + +--- + +### `sampleParentMethod()` + +*Inherited* + +#### Signature +```apex +public void sampleParentMethod() +``` + +#### Return Type +**void** \ No newline at end of file diff --git a/examples/markdown/docs/miscellaneous/Url.md b/examples/markdown/docs/miscellaneous/Url.md new file mode 100644 index 00000000..4c97b302 --- /dev/null +++ b/examples/markdown/docs/miscellaneous/Url.md @@ -0,0 +1,311 @@ +# Url Class + +Represents a uniform resource locator (URL) and provides access to parts of the URL. +Enables access to the base URL used to access your Salesforce org. + +## Usage +Use the methods of the `System.URL` class to create links to objects in your organization. Such objects can be files, images, +logos, or records that you want to include in external emails, in activities, or in Chatter posts. For example, you can create +a link to a file uploaded as an attachment to a Chatter post by concatenating the Salesforce base URL with the file ID: + +```apex +// Get a file uploaded through Chatter. +ContentDocument doc = [SELECT Id FROM ContentDocument + WHERE Title = 'myfile']; +// Create a link to the file. +String fullFileURL = URL.getOrgDomainURL().toExternalForm() + +'/' + doc.id; +system.debug(fullFileURL); +``` + + +The following example creates a link to a Salesforce record. The full URL is created by concatenating the Salesforce base +URL with the record ID. + +```ape +Account acct = [SELECT Id FROM Account WHERE Name = 'Acme' LIMIT 1]; +String fullRecordURL = URL.getOrgDomainURL().toExternalForm() + '/' + acct.Id; +``` + + +## Example +In this example, the base URL and the full request URL of the current Salesforce server instance are retrieved. Next, a URL +pointing to a specific account object is created. Finally, components of the base and full URL are obtained. This example +prints out all the results to the debug log output. + +```apex +// Create a new account called Acme that we will create a link for later. +Account myAccount = new Account(Name='Acme'); +insert myAccount; + +// Get the base URL. +String sfdcBaseURL = URL.getOrgDomainURL().toExternalForm(); +System.debug('Base URL: ' + sfdcBaseURL ); + +// Get the URL for the current request. +String currentRequestURL = URL.getCurrentRequestUrl().toExternalForm(); +System.debug('Current request URL: ' + currentRequestURL); + +// Create the account URL from the base URL. +String accountURL = URL.getOrgDomainURL().toExternalForm() + + '/' + myAccount.Id; +System.debug('URL of a particular account: ' + accountURL); + +// Get some parts of the base URL. +System.debug('Host: ' + URL.getOrgDomainURL().getHost()); +System.debug('Protocol: ' + URL.getOrgDomainURL().getProtocol()); + +// Get the query string of the current request. +System.debug('Query: ' + URL.getCurrentRequestUrl().getQuery()); +``` + + +## Version Behavior Changes +In API version 41.0 and later, Apex URL objects are represented by the java.net.URI type, not the java.net.URL type. +The API version in which the URL object was instantiated determines the behavior of subsequent method calls to the +specific instance. Salesforce strongly encourages you to use API 41.0 and later versions for fully RFC-compliant URL +parsing that includes proper handling of edge cases of complex URL structures. API 41.0 and later versions also enforce +that inputs are valid, RFC-compliant URL or URI strings. + +* [URL Constructors](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_constructors) +* [URL Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_url.htm#apex_System_URL_methods) + +**See Also** +* [URL Class](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_url.htm) + +## Namespace +ns + +## Constructors +### `Url(spec)` + +Creates a new instance of the URL class using the specified string representation of the URL. + +#### Signature +```apex +global Url(String spec) +``` + +#### Parameters +| Name | Type | Description | +|------|------|-------------| +| spec | String | The string to parse as a URL. | + +--- + +### `Url(context, spec)` + +Creates a new instance of the URL class by parsing the specified spec within the specified context. + +**Usage** + +The new URL is created from the given context URL and the spec argument as described in RFC2396 "Uniform Resource Identifiers : Generic * Syntax" : +```xml +://?# +``` + + +For more information about the arguments of this constructor, see the corresponding URL(java.net.URL, java.lang.String) constructor for Java. + +#### Signature +```apex +global Url(Url context, String spec) +``` + +#### Parameters +| Name | Type | Description | +|------|------|-------------| +| context | [Url](Url.md) | The context in which to parse the specification. | +| spec | String | The string to parse as a URL. | + +--- + +### `Url(protocol, host, file)` + +Creates a new instance of the URL class using the specified protocol, host, and file on the host. The default port for the specified protocol is used. + +#### Signature +```apex +global Url(String protocol, String host, String file) +``` + +#### Parameters +| Name | Type | Description | +|------|------|-------------| +| protocol | String | The protocol name for this URL. | +| host | String | The host name for this URL. | +| file | String | The file name for this URL. | + +--- + +### `Url(protocol, host, port, file)` + +Creates a new instance of the URL class using the specified protocol, host, port number, and file on the host. + +#### Signature +```apex +global Url(String protocol, String host, Integer port, String file) +``` + +#### Parameters +| Name | Type | Description | +|------|------|-------------| +| protocol | String | The protocol name for this URL. | +| host | String | The host name for this URL. | +| port | Integer | The port number for this URL. | +| file | String | The file name for this URL. | + +## Methods +### `getAuthority()` + +Returns the authority portion of the current URL. + +#### Signature +```apex +global String getAuthority() +``` + +#### Return Type +**String** + +The authority portion of the current URL. + +--- + +### `getCurrentRequestUrl()` + +Returns the URL of an entire request on a Salesforce instance. + +**Usage** + +An example of a URL for an entire request is https://yourInstance.salesforce.com/apex/myVfPage.apexp. + +#### Signature +```apex +global static Url getCurrentRequestUrl() +``` + +#### Return Type +**[Url](Url.md)** + +The URL of the entire request. + +--- + +### `getDefPort()` + +Returns the default port number of the protocol associated with the current URL. + +**Usage** + +Returns -1 if the URL scheme or the stream protocol handler for the URL doesn't define a default port number. + +#### Signature +```apex +global Integer getDefPort() +``` + +#### Return Type +**Integer** + +The default port number of the protocol associated with the current URL. + +--- + +### `getFile()` + +Returns the file name of the current URL. + +#### Signature +```apex +global String getFile() +``` + +#### Return Type +**String** + +The file name of the current URL. + +--- + +### `getFileFieldURL(entityId, fieldName)` + +Returns the download URL for a file attachment. + +#### Signature +```apex +global static String getFileFieldURL(String entityId, String fieldName) +``` + +#### Parameters +| Name | Type | Description | +|------|------|-------------| +| entityId | String | Specifies the ID of the entity that holds the file data. | +| fieldName | String | Specifies the API name of a file field component, such as `AttachmentBody` . | + +#### Return Type +**String** + +The download URL for the file attachment. + +#### Example +String fileURL = +URL.getFileFieldURL( +'087000000000123' , +'AttachmentBody'); + +--- + +### `getHost()` + +Returns the host name of the current URL. + +#### Signature +```apex +global String getHost() +``` + +#### Return Type +**String** + +The host name of the current URL. + +--- + +### `getOrgDomainUrl()` + +Returns the canonical URL for your org. For example, https://MyDomainName.my.salesforce.com. + +**Usage** + +Use getOrgDomainUrl() to interact with Salesforce REST and SOAP APIs in Apex code. Get endpoints for User Interface API calls, for creating and customizing picklist value sets and custom fields, and more. + + `getOrgDomainUrl()` can access the domain URL only for the org in which the Apex code is running. + +You don't need a RemoteSiteSetting for your org to interact with the Salesforce APIs using domain URLs retrieved with this method. + +**See Also** + +* [Lightning Aura Components Developer Guide: Making API Calls from Apex](https://developer.salesforce.com/docs/atlas.en-us.250.0.lightning.meta/lightning/apex_api_calls.htm) + +#### Signature +```apex +global static Url getOrgDomainUrl() +``` + +#### Return Type +**[Url](Url.md)** + +getOrgDomainUrl() always returns the login URL for your org, regardless of context. Use that URL when making API calls to your org. + +#### Example +This example uses the Salesforce REST API to get organization limit values. For information on limits, see Limits in the REST API Developer Guide. +```apex +Http h = new Http(); +HttpRequest req = new HttpRequest(); +req.setEndpoint(Url.getOrgDomainUrl().toExternalForm() + + '/services/data/v44.0/limits'); +req.setMethod('GET'); +req.setHeader('Authorization', 'Bearer ' + UserInfo.getSessionId()); +HttpResponse res = h.send(req); +``` \ No newline at end of file diff --git a/examples/markdown/docs/sample-enums/SampleEnum.md b/examples/markdown/docs/sample-enums/SampleEnum.md new file mode 100644 index 00000000..c82b92a0 --- /dev/null +++ b/examples/markdown/docs/sample-enums/SampleEnum.md @@ -0,0 +1,36 @@ +# SampleEnum Enum + +`NAMESPACEACCESSIBLE` + +This is a sample enum. This references [ReferencedEnum](../miscellaneous/ReferencedEnum.md) . + +This description has several lines + +**Some Custom** + +Test. I can also have a [ReferencedEnum](../miscellaneous/ReferencedEnum.md) here. +And it can be multiline. + +**Mermaid** + +graph TD +A[SampleEnum] -->|references| B[ReferencedEnum] +B -->|referenced by| A + +**Group** Sample Enums + +**Author** John Doe + +**Date** 2022-01-01 + +**See** [ReferencedEnum](../miscellaneous/ReferencedEnum.md) + +## Namespace +ns + +## Values +| Value | Description | +|-------|-------------| +| VALUE1 | This is value 1 | +| VALUE2 | This is value 2 | +| VALUE3 | This is value 3 | \ No newline at end of file diff --git a/examples/markdown/docs/samplegroup/SampleClass.md b/examples/markdown/docs/samplegroup/SampleClass.md new file mode 100644 index 00000000..bda3f37f --- /dev/null +++ b/examples/markdown/docs/samplegroup/SampleClass.md @@ -0,0 +1,170 @@ +# 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 +SampleClass sample = new SampleClass(); +sample.doSomething(); + +**Inheritance** + +[BaseClass](../miscellaneous/BaseClass.md) + +**Implements** + +[SampleInterface](../miscellaneous/SampleInterface.md), +[ParentInterface](../miscellaneous/ParentInterface.md) + +## Fields +### Group Name +#### `name` + +This is a sample field. + +##### Signature +```apex +private final name +``` + +##### Type +String + +### Other +#### `sampleEnumFromBase` + +*Inherited* + +##### Signature +```apex +public sampleEnumFromBase +``` + +##### Type +[SampleEnum](../sample-enums/SampleEnum.md) + +## Properties +### Group Name +#### `someProperty` + +##### Signature +```apex +public someProperty +``` + +##### Type +String + +## Constructors +### Other +#### `SampleClass()` + +This is a sample constructor. + +##### Signature +```apex +public SampleClass() +``` + +### Other Constructors +#### `SampleClass(name)` + +##### Signature +```apex +public SampleClass(String name) +``` + +##### Parameters +| Name | Type | Description | +|------|------|-------------| +| name | String | | + +## Methods +### Available Methods +#### `doSomething()` + +##### Signature +```apex +public void doSomething() +``` + +##### Return Type +**void** + +### Deprecated Methods +#### `sayHello()` + +`DEPRECATED` + +This is a sample method. + +##### Signature +```apex +public virtual String sayHello() +``` + +##### Return Type +**String** + +A string value. + +##### Example +SampleClass sample = new SampleClass(); +sample.doSomething(); + +## Classes +### SomeInnerClass Class + +#### Fields +##### `someInnerField` + +###### Signature +```apex +public someInnerField +``` + +###### Type +String + +#### Methods +##### `doSomething()` + +###### Signature +```apex +public void doSomething() +``` + +###### Return Type +**void** + +## Enums +### SomeEnum Enum + +This enum is used for foo and bar. + +#### Values +| Value | Description | +|-------|-------------| +| TEST_1 | This is a test. | +| TEST_2 | | +| TEST_3 | | + +## Interfaces +### SomeInterface Interface + +#### Methods +##### `doSomething()` + +###### Signature +```apex +public void doSomething() +``` + +###### Return Type +**void** \ No newline at end of file diff --git a/examples/markdown/force-app/classes/BaseClass.cls-meta.xml b/examples/markdown/force-app/classes/BaseClass.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/markdown/force-app/classes/BaseClass.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/examples/markdown/force-app/classes/MultiInheritanceClass.cls-meta.xml b/examples/markdown/force-app/classes/MultiInheritanceClass.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/markdown/force-app/classes/MultiInheritanceClass.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/examples/markdown/force-app/classes/ParentInterface.cls-meta.xml b/examples/markdown/force-app/classes/ParentInterface.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/markdown/force-app/classes/ParentInterface.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/examples/markdown/force-app/classes/ReferencedEnum.cls-meta.xml b/examples/markdown/force-app/classes/ReferencedEnum.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/markdown/force-app/classes/ReferencedEnum.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/examples/markdown/force-app/classes/SampleClass.cls-meta.xml b/examples/markdown/force-app/classes/SampleClass.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/markdown/force-app/classes/SampleClass.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/examples/markdown/force-app/classes/SampleEnum.cls-meta.xml b/examples/markdown/force-app/classes/SampleEnum.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/markdown/force-app/classes/SampleEnum.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/examples/markdown/force-app/classes/SampleException.cls-meta.xml b/examples/markdown/force-app/classes/SampleException.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/markdown/force-app/classes/SampleException.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/examples/markdown/force-app/classes/SampleInterface.cls-meta.xml b/examples/markdown/force-app/classes/SampleInterface.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/markdown/force-app/classes/SampleInterface.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active + diff --git a/examples/markdown/force-app/classes/Url.cls-meta.xml b/examples/markdown/force-app/classes/Url.cls-meta.xml new file mode 100644 index 00000000..998805a8 --- /dev/null +++ b/examples/markdown/force-app/classes/Url.cls-meta.xml @@ -0,0 +1,5 @@ + + + 62.0 + Active +