@cparra/apexdocs 2.25.0-alpha.6 → 2.25.0-alpha.9

package/dist/index.d.ts

@@ -1,9 +1,13 @@
 import { SetOptional } from 'type-fest';
 
+/**
+ * The configurable hooks that can be used to modify the output of the generator.
+ */
 type ConfigurableHooks = {
   transformReferenceGuide: TransformReferenceGuide;
   transformDocs: TransformDocs;
   transformDocPage: TransformDocPage;
+  transformReference: TransformReference;
 };
 
 type UserDefinedMarkdownConfig = {
@@ -17,46 +21,80 @@ type UserDefinedMarkdownConfig = {
   includeMetadata: boolean;
 } & Partial<ConfigurableHooks>;
 
+type SourceFileMetadata = {
+  filePath: string;
+  name: string;
+  type: 'interface' | 'class' | 'enum';
+};
+
+type DocPageReference = {
+  source: SourceFileMetadata;
+  // The name under which the type should be displayed in the documentation.
+  // By default, this will match the source.name, but it can be configured by the user.
+  displayName: string;
+  // The location of the file relative to the root of the documentation.
+  pathFromRoot: string;
+};
+
 type Frontmatter = string | Record<string, unknown> | null;
 
 type ReferenceGuidePageData = {
-  directory: string;
   frontmatter: Frontmatter;
   content: string;
-  fileExtension: string;
-  fileName: string;
+  filePath: string;
 };
 
 type DocPageData = {
-  source: {
-    filePath: string;
-    name: string;
-    type: 'interface' | 'class' | 'enum';
-  };
+  source: SourceFileMetadata;
   group: string | null;
-  fileName: string;
-  fileExtension: string;
-  directory: string;
+  filePath: string;
   frontmatter: Frontmatter;
   content: string;
 };
 
+/**
+ * Represents a file to be skipped.
+ */
 type Skip = {
   readonly _tag: 'Skip';
 };
 
 // Configurable Hooks
 
+type ConfigurableDocPageReference = Omit<DocPageReference, 'source'>;
+
+type ConfigurableDocPageData = Omit<DocPageData, 'source' | 'filePath'>;
+
+/**
+ * Allows changing where the files are written to.
+ */
+type TransformReference = (
+  reference: DocPageReference,
+) => Partial<ConfigurableDocPageReference> | Promise<ConfigurableDocPageReference>;
+
+/**
+ * Allows changing the frontmatter and content of the reference guide, or even if creating a reference
+ * guide will be skipped altogether.
+ */
 type TransformReferenceGuide = (
   referenceGuide: ReferenceGuidePageData,
 ) => Partial<ReferenceGuidePageData> | Skip | Promise<Partial<ReferenceGuidePageData> | Skip>;
 
+/**
+ * The main purpose if for allowing for doc pages to be skipped, but it can also be used to change the frontmatter
+ * and content of the doc pages.
+ */
 type TransformDocs = (docs: DocPageData[]) => DocPageData[] | Promise<DocPageData[]>;
 
-type TransformDocPage = (doc: DocPageData) => Partial<DocPageData> | Promise<Partial<DocPageData>>;
+/**
+ * Allows changing the frontmatter and content of the doc pages.
+ */
+type TransformDocPage = (
+  doc: DocPageData,
+) => Partial<ConfigurableDocPageData> | Promise<Partial<ConfigurableDocPageData>>;
 
 type ConfigurableMarkdownConfig = Omit<SetOptional<UserDefinedMarkdownConfig, 'targetDir' | 'scope' | 'defaultGroupName' | 'includeMetadata' | 'sortMembersAlphabetically'>, 'targetGenerator'>;
 declare function defineMarkdownConfig(config: ConfigurableMarkdownConfig): UserDefinedMarkdownConfig;
 declare function skip(): Skip;
 
-export { type ConfigurableHooks, type DocPageData, type ReferenceGuidePageData, defineMarkdownConfig, skip };
+export { type ConfigurableHooks, type DocPageData, type DocPageReference, type ReferenceGuidePageData, defineMarkdownConfig, skip };

package/examples/plain-markdown/docs/index.md

@@ -2,36 +2,32 @@
 
 ## Miscellaneous
 
-### [ns.BaseClass](./Miscellaneous/ns.BaseClass.md)
+### [BaseClass](miscellaneous/BaseClass.md)
 
-### [ns.MultiInheritanceClass](./Miscellaneous/ns.MultiInheritanceClass.md)
+### [MultiInheritanceClass](miscellaneous/MultiInheritanceClass.md)
 
-### [ns.ParentInterface](./Miscellaneous/ns.ParentInterface.md)
+### [ParentInterface](miscellaneous/ParentInterface.md)
 
-### [ns.ReferencedEnum](./Miscellaneous/ns.ReferencedEnum.md)
+### [ReferencedEnum](miscellaneous/ReferencedEnum.md)
 
-### [ns.SampleException](./Miscellaneous/ns.SampleException.md)
+### [SampleException](miscellaneous/SampleException.md)
 
 This is a sample exception.
 
-### [ns.SampleInterface](./Miscellaneous/ns.SampleInterface.md)
+### [SampleInterface](miscellaneous/SampleInterface.md)
 
 This is a sample interface
 
-### [ns.Url](./Miscellaneous/ns.Url.md)
+### [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
@@ -42,76 +38,72 @@ String fullFileURL = URL.getOrgDomainURL().toExternalForm() +
 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
 
-### [ns.SampleEnum](./Sample-Enums/ns.SampleEnum.md)
-
-This is a sample enum. This references [ns.ReferencedEnum](./Miscellaneous/ns.ReferencedEnum.md) . 
+### [SampleEnum](sample-enums/SampleEnum.md)
 
+This is a sample enum. This references [ReferencedEnum](miscellaneous/ReferencedEnum.md) . 
+ 
 This description has several lines
 
 ## SampleGroup
 
-### [ns.SampleClass](./SampleGroup/ns.SampleClass.md)
+### [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.

package/examples/plain-markdown/docs/{Miscellaneous/ns.BaseClass.md → miscellaneous/BaseClass.md}

@@ -13,4 +13,4 @@ public sampleEnumFromBase
 ```
 
 #### Type
-[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
+[SampleEnum](../sample-enums/SampleEnum.md)

package/examples/plain-markdown/docs/{Miscellaneous/ns.MultiInheritanceClass.md → miscellaneous/MultiInheritanceClass.md}

@@ -4,7 +4,8 @@
 ns
 
 **Inheritance**
-[ns.SampleClass](../SampleGroup/ns.SampleClass.md) < [ns.BaseClass](./ns.BaseClass.md)
+
+[SampleClass](../samplegroup/SampleClass.md) < [BaseClass](../miscellaneous/BaseClass.md)
 
 ## Fields
 ### `sampleEnumFromBase`
@@ -17,7 +18,7 @@ public sampleEnumFromBase
 ```
 
 #### Type
-[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
+[SampleEnum](../sample-enums/SampleEnum.md)
 
 ## Properties
 ### Group Name
@@ -67,7 +68,5 @@ public virtual String sayHello()
 A string value.
 
 ##### Example
-```apex
-SampleClass sample = new SampleClass();
-sample.doSomething();
-```
+SampleClass sample &#x3D; new SampleClass(); 
+sample.doSomething();

package/examples/plain-markdown/docs/{Miscellaneous/ns.SampleException.md → miscellaneous/SampleException.md}

@@ -5,11 +5,9 @@ This is a sample exception.
 **Usage** 
 
 You can use the exception the following way. 
-
-You can also take a look at [ns.SampleClass](../SampleGroup/ns.SampleClass.md) to see how it is used. 
-
+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();
@@ -22,4 +20,5 @@ try {
 ns
 
 **Inheritance**
+
 Exception

package/examples/plain-markdown/docs/{Miscellaneous/ns.SampleInterface.md → miscellaneous/SampleInterface.md}

@@ -4,33 +4,30 @@
 
 This is a sample interface
 
+**Mermaid** 
+
+graph TD 
+A[SampleInterface] -->|extends| B[ParentInterface] 
+B -->|extends| C[GrandParentInterface] 
+C -->|extends| D[GreatGrandParentInterface]
+
 **Author** John Doe
 
 **Date** 2020-01-01
 
-**See** [ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
+**See** [SampleEnum](../sample-enums/SampleEnum.md)
 
-**See** [ns.ReferencedEnum](./ns.ReferencedEnum.md)
+**See** [ReferencedEnum](../miscellaneous/ReferencedEnum.md)
 
 ## Namespace
 ns
 
-## Diagram
-```mermaid
-graph TD
-   A[SampleInterface] -->|extends| B[ParentInterface]
-   B -->|extends| C[GrandParentInterface]
-   C -->|extends| D[GreatGrandParentInterface]
-```
-
 ## Example
-```apex
-SampleInterface sampleInterface = new SampleInterface();
+SampleInterface sampleInterface = new SampleInterface(); 
 sampleInterface.sampleMethod();
-```
 
 **Extends**
-[ns.ParentInterface](./ns.ParentInterface.md)
+[ParentInterface](../miscellaneous/ParentInterface.md)
 
 ## Methods
 ### `sampleMethod()`
@@ -47,6 +44,13 @@ This is a 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()
@@ -58,23 +62,13 @@ public String sampleMethod()
 Some return value
 
 #### Throws
-[ns.SampleException](./ns.SampleException.md): This is a sample exception
+[SampleException](../miscellaneous/SampleException.md): This is a sample exception
 
 AnotherSampleException: This is another sample exception
 
-#### Diagram
-```mermaid
-graph TD
-  A[SampleInterface] -->|extends| B[ParentInterface]
-  B -->|extends| C[GrandParentInterface]
-  C -->|extends| D[GreatGrandParentInterface]
-```
-
 #### Example
-```apex
-SampleInterface sampleInterface = new SampleInterface();
+SampleInterface sampleInterface = new SampleInterface(); 
 sampleInterface.sampleMethod();
-```
 
 ---
 
@@ -84,7 +78,6 @@ sampleInterface.sampleMethod();
 `DEPRECATED`
 
 This is a sample method with parameters 
-
 Sometimes it won't be possible to find a NonExistent link.
 
 #### Signature
@@ -97,10 +90,10 @@ public SampleEnum sampleMethodWithParams(String param1, Integer param2, SampleEn
 |------|------|-------------|
 | param1 | String | This is the first parameter |
 | param2 | Integer | This is the second parameter |
-| theEnum | [ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md) | This is an enum parameter |
+| theEnum | [SampleEnum](../sample-enums/SampleEnum.md) | This is an enum parameter |
 
 #### Return Type
-**[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)**
+**[SampleEnum](../sample-enums/SampleEnum.md)**
 
 Some return value
 

package/examples/plain-markdown/docs/{Miscellaneous/ns.Url.md → miscellaneous/Url.md}

@@ -1,17 +1,13 @@
 # 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
@@ -22,62 +18,59 @@ String fullFileURL = URL.getOrgDomainURL().toExternalForm() +
 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
@@ -107,11 +100,11 @@ Creates a new instance of the URL class by parsing the specified spec within the
 **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
 <scheme>://<authority><path>?<query>#<fragment>
 ```
 
+ 
 For more information about the arguments of this constructor, see the corresponding URL(java.net.URL, java.lang.String) constructor for Java.
 
 #### Signature
@@ -122,7 +115,7 @@ global Url(Url context, String spec)
 #### Parameters
 | Name | Type | Description |
 |------|------|-------------|
-| context | [ns.Url](./ns.Url.md) | The context in which to parse the specification. |
+| context | [Url](../miscellaneous/Url.md) | The context in which to parse the specification. |
 | spec | String | The string to parse as a URL. |
 
 ---
@@ -193,7 +186,7 @@ global static Url getCurrentRequestUrl()
 ```
 
 #### Return Type
-**[ns.Url](./ns.Url.md)**
+**[Url](../miscellaneous/Url.md)**
 
 The URL of the entire request.
 
@@ -256,12 +249,10 @@ global static String getFileFieldURL(String entityId, String fieldName)
 The download URL for the file attachment.
 
 #### Example
-```apex
-String fileURL =
-URL.getFileFieldURL(
-  '087000000000123' ,
-  'AttachmentBody');
-```
+String fileURL &#x3D; 
+URL.getFileFieldURL( 
+&#x27;087000000000123&#x27; , 
+&#x27;AttachmentBody&#x27;);
 
 ---
 
@@ -288,9 +279,9 @@ Returns the canonical URL for your org. For example, https://MyDomainName.my.sal
 **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&#x27;t need a RemoteSiteSetting for your org to interact with the Salesforce APIs using domain URLs retrieved with this method.
 
 **See Also** 
@@ -303,18 +294,16 @@ global static Url getOrgDomainUrl()
 ```
 
 #### Return Type
-**[ns.Url](./ns.Url.md)**
+**[Url](../miscellaneous/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
-```apex
-// This example uses the Salesforce REST API to get organization limit values. For information on limits, see Limits in the REST API Developer Guide.
-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);
-```
+// This example uses the Salesforce REST API to get organization limit values. For information on limits, see Limits in the REST API Developer Guide. 
+Http h &#x3D; new Http(); 
+HttpRequest req &#x3D; new HttpRequest(); 
+req.setEndpoint(Url.getOrgDomainUrl().toExternalForm() 
++ &#x27;/services/data/v44.0/limits&#x27;); 
+req.setMethod(&#x27;GET&#x27;); 
+req.setHeader(&#x27;Authorization&#x27;, &#x27;Bearer &#x27; + UserInfo.getSessionId()); 
+HttpResponse res &#x3D; h.send(req);

package/examples/plain-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 |

package/examples/plain-markdown/docs/{SampleGroup/ns.SampleClass.md → samplegroup/SampleClass.md}

@@ -2,7 +2,6 @@
 `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
@@ -11,17 +10,17 @@ deserunt ea officia exercitation laboris enim in duis quis enim eiusmod eu amet
 ns
 
 ## Example
-```apex
-SampleClass sample = new SampleClass();
+SampleClass sample = new SampleClass(); 
 sample.doSomething();
-```
 
 **Inheritance**
-[ns.BaseClass](../Miscellaneous/ns.BaseClass.md)
+
+[BaseClass](../miscellaneous/BaseClass.md)
 
 **Implements**
-[ns.SampleInterface](../Miscellaneous/ns.SampleInterface.md), 
-[ns.ParentInterface](../Miscellaneous/ns.ParentInterface.md)
+
+[SampleInterface](../miscellaneous/SampleInterface.md), 
+[ParentInterface](../miscellaneous/ParentInterface.md)
 
 ## Fields
 ### Group Name
@@ -48,7 +47,7 @@ public sampleEnumFromBase
 ```
 
 ##### Type
-[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
+[SampleEnum](../sample-enums/SampleEnum.md)
 
 ## Properties
 ### Group Name
@@ -116,10 +115,8 @@ public virtual String sayHello()
 A string value.
 
 ##### Example
-```apex
-SampleClass sample = new SampleClass();
+SampleClass sample = new SampleClass(); 
 sample.doSomething();
-```
 
 ## Classes
 ### SomeInnerClass Class