Merge pull request #279 from cesarParra/jsdocs

LWC documentation support.

Author: cesarParra

.idea/inspectionProfiles/Project_Default.xml

@@ -77,7 +77,7 @@ Here are some live projects using ApexDocs:
 
 ## 🚀 Features
 
-* Generate documentation for Salesforce Apex classes as Markdown files
+* Generate documentation for Salesforce code (Apex, triggers, custom objects, LWCs) as Markdown files
 * Generate an OpenApi REST specification based on `@RestResource` classes
 * Generate a changelog based on the differences between two versions of your Salesforce Apex classes
 * Support for grouping blocks of related code within a class
@@ -149,10 +149,11 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
 | `--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       |
+| `--includeMetadata `              | N/A   | Whether to include the file's meta.xml information: Whether it is active 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       |
 | `--triggersGroupName`             | N/A   | The name under which triggers will be grouped in the Reference Guide                                                                                                                                     | `Triggers`       | No       |
+| `--lwcGroupName`                  | N/A   | The name under which Lightning Web Components will be grouped in the Reference Guide                                                                                                                     | `Triggers`       | No       |
 | `--includeFieldSecurityMetadata`  | N/A   | Whether to include the compliance category and security classification for fields in the generated files.                                                                                                | `false`          | No       |
 | `--includeInlineHelpTextMetadata` | N/A   | Whether to include the inline help text for fields in the generated files.                                                                                                                               | `false`          | No       |
 
@@ -336,6 +337,15 @@ Then you only need to run the top level `apexdocs` command, and it will generate
 Note that you can still run the individual commands if you only want to generate one type of documentation by
 providing the subcommand, e.g `apexdocs markdown` or `apexdocs changelog`.
 
+### LWC Documentation Limitations
+
+ApexDocs supports generating documentation for Lightning Web Components (LWC) as well, but please
+be aware of the following limitations:
+
+* Only components marked as `isExposed=true` in the component's meta.xml file will be documented.
+* At the moment, any JSDoc comments are ignored, documentation is based solely on the component's metadata.
+* Changelog generation does not include changes to LWCs.
+
 ### Excluding Files from Being Documented
 
 Any pattern included in the `.forceignore` file will be excluded from the documentation.
@@ -525,7 +535,7 @@ macro, and the value is a function that returns the text to inject in place of t
 
 ```typescript
 type MacroSourceMetadata = {
-  type: 'apex' | 'customobject' | 'customfield' | 'custommetadata' | 'trigger';
+  type: 'apex' | 'customobject' | 'customfield' | 'custommetadata' | 'trigger' | 'lwc';
   name: string;
   filePath: string;
 };

README.md

@@ -45,12 +45,6 @@ Represents an event that people can register for.
 
 Used to store the U.S. social security number in 9 digit format.
 
-**Compliance Group**
-PII
-
-**Security Classification**
-Internal
-
 **API Name**
 
 `ns__Social_Security_Number__c`

examples/markdown/docs/custom-objects/Event__c.md

@@ -12,24 +12,30 @@ Represents an event that people can register for.
 
 ### [Price_Component__c](custom-objects/Price_Component__c.md)
 
-### [Product_Price_Component__c](custom-objects/Product_Price_Component__c.md)
-
 ### [Product__c](custom-objects/Product__c.md)
 
 Product that is sold or available for sale.
 
-### [Sales_Order_Line__c](custom-objects/Sales_Order_Line__c.md)
-
-Represents a line item on a sales order.
+### [Product_Price_Component__c](custom-objects/Product_Price_Component__c.md)
 
 ### [Sales_Order__c](custom-objects/Sales_Order__c.md)
 
 Custom object for tracking sales orders.
 
+### [Sales_Order_Line__c](custom-objects/Sales_Order_Line__c.md)
+
+Represents a line item on a sales order.
+
 ### [Speaker__c](custom-objects/Speaker__c.md)
 
 Represents a speaker at an event.
 
+## Lightning Web Components
+
+### [accordion](lightning-web-components/accordion.md)
+
+Accordion
+
 ## Miscellaneous
 
 ### [BaseClass](miscellaneous/BaseClass.md)

examples/markdown/docs/index.md

@@ -0,0 +1,57 @@
+# accordion
+
+`Exposed`
+
+Accordion
+
+## Targets
+- lightningCommunity__Default
+- lightningCommunity__Page
+
+## Target Configs
+
+### lightningCommunity__Default
+
+#### Properties
+
+**Auto Collapse** `autoCollapse`
+
+Whether to automatically collapse the accordion when a new section is expanded.
+
+- **Type:** Boolean
+- **Required:** false
+
+**Context URL Parameter** `contextUrlParam`
+
+Optional - The name of the URL parameter that contains the context ID.
+
+- **Type:** String
+- **Required:** false
+
+**Formula Expression** `expr`
+
+Formula expression to be evaluated.
+
+- **Type:** String
+- **Required:** true
+
+**Flush Style** `flushStyle`
+
+Removes the background color and rounded borders from the accordion component.
+
+- **Type:** Boolean
+- **Required:** false
+
+**Preview Context ID** `previewContextId`
+
+Optional - The ID of the context record to use when previewing the component in the builder.
+
+- **Type:** String
+- **Required:** false
+
+**Respect Sharing** `respectSharing`
+
+Whether to run the evaluation with or without sharing.
+
+- **Type:** Boolean
+- **Required:** false

examples/markdown/docs/lightning-web-components/accordion.md

@@ -2,7 +2,7 @@
 
 This is a sample exception.
 
-**Usage** 
+**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. 

examples/markdown/docs/miscellaneous/SampleException.md

@@ -4,7 +4,7 @@
 
 This is a sample interface
 
-**Mermaid** 
+**Mermaid**
 
 ```mermaid
 graph TD
@@ -40,15 +40,15 @@ sampleInterface.sampleMethod();
 
 This is a sample method
 
-**Custom Tag** 
+**Custom Tag**
 
 This is a custom tag
 
-**Another Custom Tag** 
+**Another Custom Tag**
 
 This is another custom tag
 
-**Mermaid** 
+**Mermaid**
 
 graph TD 
 A[SampleInterface] -->|extends| B[ParentInterface] 

examples/markdown/docs/miscellaneous/SampleInterface.md

@@ -97,7 +97,7 @@ global Url(String spec)
 
 Creates a new instance of the URL class by parsing the specified spec within the specified context.
 
-**Usage** 
+**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
@@ -176,7 +176,7 @@ The authority portion of the current URL.
 
 Returns the URL of an entire request on a Salesforce instance.
 
-**Usage** 
+**Usage**
 
 An example of a URL for an entire request is https://yourInstance.salesforce.com/apex/myVfPage.apexp.
 
@@ -196,7 +196,7 @@ The URL of the entire request.
 
 Returns the default port number of the protocol associated with the current URL.
 
-**Usage** 
+**Usage**
 
 Returns -1 if the URL scheme or the stream protocol handler for the URL doesn't define a default port number.
 
@@ -276,15 +276,15 @@ The host name of the current URL.
 
 Returns the canonical URL for your org. For example, https://MyDomainName.my.salesforce.com.
 
-**Usage** 
+**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** 
+**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)
 

examples/markdown/docs/miscellaneous/Url.md

@@ -6,12 +6,12 @@ This is a sample enum. This references [ReferencedEnum](../miscellaneous/Referen
 
 This description has several lines
 
-**Some Custom** 
+**Some Custom**
 
 Test. I can also have a [ReferencedEnum](../miscellaneous/ReferencedEnum.md) here. 
 And it can be multiline.
 
-**Mermaid** 
+**Mermaid**
 
 graph TD 
 A[SampleEnum] -->|references| B[ReferencedEnum] 

examples/markdown/docs/sample-enums/SampleEnum.md

@@ -0,0 +1,7 @@
+<template>
+    <c-expression-element-container cannot-show-preview={cannotShowPreview} error={error} loading={loading}>
+        <div if:true={ready}>
+            <c-accordion-base items={computed} auto-collapse={autoCollapse} flush-style={flushStyle}></c-accordion-base>
+        </div>
+    </c-expression-element-container>
+</template>