@cparra/apexdocs 3.4.0 → 3.4.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 +11 -11
- package/dist/cli/generate.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -111,17 +111,17 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
|
|
|
111
111
|
|
|
112
112
|
#### Flags
|
|
113
113
|
|
|
114
|
-
| Flag
|
|
115
|
-
|
|
116
|
-
| `--sourceDir`
|
|
117
|
-
| `--targetDir`
|
|
118
|
-
| `--scope`
|
|
119
|
-
| `--defaultGroupName`
|
|
120
|
-
| `--namespace`
|
|
121
|
-
| `--sortAlphabetically`
|
|
122
|
-
| `--includeMetadata `
|
|
123
|
-
| `--linkingStrategy`
|
|
124
|
-
| `--
|
|
114
|
+
| Flag | Alias | Description | Default | Required |
|
|
115
|
+
|----------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|----------|
|
|
116
|
+
| `--sourceDir` | `-s` | The directory where the source files are located. | N/A | Yes |
|
|
117
|
+
| `--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 |
|
|
119
|
+
| `--defaultGroupName` | N/A | The default group name to use when a group is not specified. | `Miscellaneous` | No |
|
|
120
|
+
| `--namespace` | N/A | The package namespace, if any. If provided, it will be added to the generated files. | N/A | No |
|
|
121
|
+
| `--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 |
|
|
122
|
+
| `--includeMetadata ` | N/A | Whether to include the file's meta.xml information: Whether it is active and and the API version | `false` | No |
|
|
123
|
+
| `--linkingStrategy` | N/A | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none` | `relative` | No |
|
|
124
|
+
| `--customObjectsGroupName` | N/A | The name under which custom objects will be grouped in the Reference Guide | `Custom Objects` | No |
|
|
125
125
|
|
|
126
126
|
##### Linking Strategy
|
|
127
127
|
|
package/dist/cli/generate.js
CHANGED
|
@@ -75,7 +75,7 @@ const markdownOptions = {
|
|
|
75
75
|
default: logger$1.markdownDefaults.defaultGroupName,
|
|
76
76
|
describe: "Defines the @group name to be used when a file does not specify it."
|
|
77
77
|
},
|
|
78
|
-
|
|
78
|
+
customObjectsGroupName: {
|
|
79
79
|
type: "string",
|
|
80
80
|
default: logger$1.markdownDefaults.customObjectsGroupName,
|
|
81
81
|
describe: "The name under which custom objects will be grouped in the Reference Guide"
|