Skip to content

Commit 8f5b418

Browse files
committed
READMe updates
1 parent 8ffaa51 commit 8f5b418

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
115115
|----------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|----------|
116116
| `--sourceDir` | `-s` | The directory where the source files are located. | N/A | Yes |
117117
| `--targetDir` | `-t` | The directory where the generated files will be placed. | `docs` | No |
118-
| `--scope` | `-p` | A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. | `global` | No |
118+
| `--scope` | `-p` | A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. | `[global]` | No |
119+
| `--customObjectVisibility` | `-v` | Controls which custom objects are documented. Values should be separated by a space. | `[public]` | No |
119120
| `--defaultGroupName` | N/A | The default group name to use when a group is not specified. | `Miscellaneous` | No |
120121
| `--namespace` | N/A | The package namespace, if any. If provided, it will be added to the generated files. | N/A | No |
121122
| `--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 |
@@ -184,14 +185,15 @@ apexdocs openapi -s force-app -t docs -n MyNamespace --title "My Custom OpenApi
184185

185186
#### Flags
186187

187-
| Flag | Alias | Description | Default | Required |
188-
|------------------------|-------|--------------------------------------------------------------------|-------------|----------|
189-
| `--previousVersionDir` | `-p` | The directory location of the previous version of the source code. | N/A | Yes |
190-
| `--currentVersionDir` | `-t` | The directory location of the current version of the source code. | N/A | Yes |
191-
| `--targetDir` | `-t` | The directory location where the changelog file will be generated. | `./docs/` | No |
192-
| `--fileName` | N/A | The name of the changelog file to be generated. | `changelog` | No |
193-
| `--scope` | N/A | The list of scope to respect when generating the changelog. | ['global'] | No |
194-
| `--skipIfNoChanges` | N/A | Whether to skip generating the changelog if there are no changes. | `true` | No |
188+
| Flag | Alias | Description | Default | Required |
189+
|----------------------------|-------|--------------------------------------------------------------------------------------|-------------|----------|
190+
| `--previousVersionDir` | `-p` | The directory location of the previous version of the source code. | N/A | Yes |
191+
| `--currentVersionDir` | `-t` | The directory location of the current version of the source code. | N/A | Yes |
192+
| `--targetDir` | `-t` | The directory location where the changelog file will be generated. | `./docs/` | No |
193+
| `--fileName` | N/A | The name of the changelog file to be generated. | `changelog` | No |
194+
| `--scope` | N/A | The list of scope to respect when generating the changelog. | ['global'] | No |
195+
| `--customObjectVisibility` | `-v` | Controls which custom objects are documented. Values should be separated by a space. | ['public'] | No |
196+
| `--skipIfNoChanges` | N/A | Whether to skip generating the changelog if there are no changes. | `true` | No |
195197

196198
#### Sample Usage
197199

0 commit comments

Comments
 (0)