@cparra/apexdocs 2.5.0-beta.0 → 2.5.0
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 +9 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -114,15 +114,15 @@ apexdocs-generate
|
|
|
114
114
|
|
|
115
115
|
The CLI supports the following parameters:
|
|
116
116
|
|
|
117
|
-
| Parameter | Alias | Description
|
|
118
|
-
|
|
119
|
-
| --sourceDir | -s | The directory location which contains your apex .cls classes.
|
|
120
|
-
| --targetDir | -t | The directory location where documentation will be generated to.
|
|
121
|
-
| --recursive | -r | Whether .cls classes will be searched for recursively in the directory provided.
|
|
122
|
-
| --scope | -p | A list of scopes to document. Values should be separated by a space, e.g --scope public private
|
|
123
|
-
| --targetGenerator | -g | Define the static file generator for which the documents will be created. Currently supports jekyll and
|
|
124
|
-
| --indexOnly | N/A | Defines whether only the index file should be generated.
|
|
125
|
-
| --defaultGroupName | N/A | Defines the `@group` name to be used when a file does not specify it.
|
|
117
|
+
| Parameter | Alias | Description | Default | Required |
|
|
118
|
+
|--------------------|-------|------------------------------------------------------------------------------------------------------------------------------------------|-----------------|----------|
|
|
119
|
+
| --sourceDir | -s | The directory location which contains your apex .cls classes. | N/A | Yes |
|
|
120
|
+
| --targetDir | -t | The directory location where documentation will be generated to. | `docs` | No |
|
|
121
|
+
| --recursive | -r | Whether .cls classes will be searched for recursively in the directory provided. | `true` | No |
|
|
122
|
+
| --scope | -p | A list of scopes to document. Values should be separated by a space, e.g --scope public private | `global` | No |
|
|
123
|
+
| --targetGenerator | -g | Define the static file generator for which the documents will be created. Currently supports: `jekyll`, `docsify`, and `plain-markdown`. | `jekyll` | No |
|
|
124
|
+
| --indexOnly | N/A | Defines whether only the index file should be generated. | `false` | No |
|
|
125
|
+
| --defaultGroupName | N/A | Defines the `@group` name to be used when a file does not specify it. | `Miscellaneous` | No |
|
|
126
126
|
|
|
127
127
|
|
|
128
128
|
### Importing to your project
|