Skip to content

Commit a553ba7

Browse files
cesarParracesarParra
committed
3.4 prep
1 parent 7346928 commit a553ba7

File tree

3 files changed

+24
-598
lines changed

3 files changed

+24
-598
lines changed

‎README.md‎

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -111,16 +111,17 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
111111

112112
#### Flags
113113

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 |
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+
| `--customObjectGroupName` | N/A | The name under which custom objects will be grouped in the Reference Guide | `Custom Objects` | No |
124125

125126
##### Linking Strategy
126127

@@ -289,12 +290,12 @@ Then you only need to run the top level `apexdocs` command, and it will generate
289290
Note that you can still run the individual commands if you only want to generate one type of documentation by
290291
providing the subcommand, e.g `apexdocs markdown` or `apexdocs changelog`.
291292

292-
### Excluding Tags from Appearing in the Documentation
293+
### Excluding Files from Being Documented
293294

294-
Note: Only works for Markdown documentation.
295+
Any pattern included in the `.forceignore` file will be excluded from the documentation.
295296

296-
You can exclude tags from appearing in the documentation by using the `excludeTags` property in the configuration file,
297-
which allow you to pass a list of tags that you want to exclude from the documentation.
297+
Additionally, you can exclude one or multiple files from being documented by providing a list of glob patterns to
298+
the `exclude` property in the configuration file.
298299

299300
```typescript
300301
import { defineMarkdownConfig } from "@cparra/apexdocs";
@@ -303,15 +304,17 @@ export default defineMarkdownConfig({
303304
sourceDir: 'force-app',
304305
targetDir: 'docs',
305306
scope: ['global', 'public'],
306-
excludeTags: ['internal', 'ignore'],
307+
exclude: ['**/MyClass.cls', '**/MyOtherClass.cls'],
307308
...
308309
});
309310
```
310311

311-
### Excluding Files from Being Documented
312+
### Excluding Tags from Appearing in the Documentation
312313

313-
You can exclude one or multiple files from being documented by providing a list of glob patterns to
314-
the `exclude` property in the configuration file.
314+
Note: Only works for Markdown documentation.
315+
316+
You can exclude tags from appearing in the documentation by using the `excludeTags` property in the configuration file,
317+
which allow you to pass a list of tags that you want to exclude from the documentation.
315318

316319
```typescript
317320
import { defineMarkdownConfig } from "@cparra/apexdocs";
@@ -320,7 +323,7 @@ export default defineMarkdownConfig({
320323
sourceDir: 'force-app',
321324
targetDir: 'docs',
322325
scope: ['global', 'public'],
323-
exclude: ['**/MyClass.cls', '**/MyOtherClass.cls'],
326+
excludeTags: ['internal', 'ignore'],
324327
...
325328
});
326329
```

0 commit comments

Comments
 (0)