@cparra/apexdocs 3.17.0 → 3.17.1-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -0
- package/dist/{logger-Cr1iCXZc.js → Apexdocs-DPBWi8Yn.js} +801 -537
- package/dist/cli/generate.js +99 -44
- package/dist/index.js +12 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -159,6 +159,7 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
|
|
|
159
159
|
| `--includeInlineHelpTextMetadata` | N/A | Whether to include the inline help text for fields in the generated files. | `false` | No |
|
|
160
160
|
| `--parallelReflection` | N/A | Parallelize CPU-heavy reflection via worker threads. | `true` | No |
|
|
161
161
|
| `--parallelReflectionMaxWorkers` | N/A | Maximum number of worker threads to use for parallel reflection. Defaults to a reasonable value based on CPU count. | N/A | No |
|
|
162
|
+
| `--debug` | N/A | Enable debug logging. Prints file-by-file parsing progress and success/failure. | `false` | No |
|
|
162
163
|
|
|
163
164
|
> **Note:** The `*` in the Required column indicates that **one** of the source directory options must be specified:
|
|
164
165
|
> - `--sourceDir` (single directory or array of directories)
|
|
@@ -216,6 +217,7 @@ apexdocs markdown -s force-app -t docs -p global public namespaceaccessible -n M
|
|
|
216
217
|
| `--apiVersion` | N/A | The version of the API. | `1.0.0` | No |
|
|
217
218
|
| `--parallelReflection` | N/A | Parallelize CPU-heavy reflection via worker threads. | `true` | No |
|
|
218
219
|
| `--parallelReflectionMaxWorkers` | N/A | Maximum number of worker threads to use for parallel reflection. Defaults to a reasonable value. | N/A | No |
|
|
220
|
+
| `--debug` | N/A | Enable debug logging. Prints file-by-file parsing progress and success/failure. | `false` | No |
|
|
219
221
|
|
|
220
222
|
#### Sample Usage
|
|
221
223
|
|
|
@@ -240,6 +242,7 @@ apexdocs openapi -s force-app -t docs -n MyNamespace --title "My Custom OpenApi
|
|
|
240
242
|
| `--skipIfNoChanges` | N/A | Whether to skip generating the changelog if there are no changes. | `true` | No |
|
|
241
243
|
| `--parallelReflection` | N/A | Parallelize CPU-heavy reflection via worker threads. | `true` | No |
|
|
242
244
|
| `--parallelReflectionMaxWorkers` | N/A | Maximum number of worker threads to use for parallel reflection. Defaults to a reasonable value. | N/A | No |
|
|
245
|
+
| `--debug` | N/A | Enable debug logging. Prints file-by-file parsing progress and success/failure. | `false` | No |
|
|
243
246
|
|
|
244
247
|
#### Sample Usage
|
|
245
248
|
|