Skip to content

Commit c2d90de

Browse files
committed
Doc updates
1 parent 3940a17 commit c2d90de

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Here are some live projects using ApexDocs:
7777

7878
## 🚀 Features
7979

80-
* Generate documentation for Salesforce Apex classes as Markdown files
80+
* Generate documentation for Salesforce code (Apex, triggers, custom objects, LWCs) as Markdown files
8181
* Generate an OpenApi REST specification based on `@RestResource` classes
8282
* Generate a changelog based on the differences between two versions of your Salesforce Apex classes
8383
* Support for grouping blocks of related code within a class
@@ -149,7 +149,7 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
149149
| `--defaultGroupName` | N/A | The default group name to use when a group is not specified. | `Miscellaneous` | No |
150150
| `--namespace` | N/A | The package namespace, if any. If provided, it will be added to the generated files. | N/A | No |
151151
| `--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 |
152-
| `--includeMetadata ` | N/A | Whether to include the file's meta.xml information: Whether it is active and and the API version | `false` | No |
152+
| `--includeMetadata ` | N/A | Whether to include the file's meta.xml information: Whether it is active and the API version | `false` | No |
153153
| `--linkingStrategy` | N/A | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none` | `relative` | No |
154154
| `--customObjectsGroupName` | N/A | The name under which custom objects will be grouped in the Reference Guide | `Custom Objects` | No |
155155
| `--triggersGroupName` | N/A | The name under which triggers will be grouped in the Reference Guide | `Triggers` | No |
@@ -526,7 +526,7 @@ macro, and the value is a function that returns the text to inject in place of t
526526

527527
```typescript
528528
type MacroSourceMetadata = {
529-
type: 'apex' | 'customobject' | 'customfield' | 'custommetadata' | 'trigger';
529+
type: 'apex' | 'customobject' | 'customfield' | 'custommetadata' | 'trigger' | 'lwc';
530530
name: string;
531531
filePath: string;
532532
};

0 commit comments

Comments
 (0)