@cparra/apexdocs 3.7.3 → 3.8.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 -0
- package/dist/cli/generate.js +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/{logger-B7R1BwqQ.js → logger-B0wNVQij.js} +475 -279
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -309,6 +309,15 @@ export default defineMarkdownConfig({
|
|
|
309
309
|
});
|
|
310
310
|
```
|
|
311
311
|
|
|
312
|
+
You can also leverage the `exclude` property to indirectly modify things like custom metadata records you do
|
|
313
|
+
not want included in the custom metadata type object documentation.
|
|
314
|
+
|
|
315
|
+
```typescript
|
|
316
|
+
//...
|
|
317
|
+
exclude: ['**/*.md-meta.xml']
|
|
318
|
+
//...
|
|
319
|
+
```
|
|
320
|
+
|
|
312
321
|
### Excluding Tags from Appearing in the Documentation
|
|
313
322
|
|
|
314
323
|
Note: Only works for Markdown documentation.
|
package/dist/cli/generate.js
CHANGED
package/dist/index.d.ts
CHANGED
|
@@ -25,7 +25,7 @@ type CliConfigurableMarkdownConfig = {
|
|
|
25
25
|
};
|
|
26
26
|
|
|
27
27
|
type UserDefinedMarkdownConfig = {
|
|
28
|
-
targetGenerator: 'markdown'
|
|
28
|
+
targetGenerator: 'markdown';
|
|
29
29
|
excludeTags: string[];
|
|
30
30
|
exclude: string[];
|
|
31
31
|
} & CliConfigurableMarkdownConfig &
|
|
@@ -55,7 +55,7 @@ type UserDefinedChangelogConfig = {
|
|
|
55
55
|
|
|
56
56
|
type UserDefinedConfig = UserDefinedMarkdownConfig | UserDefinedOpenApiConfig | UserDefinedChangelogConfig;
|
|
57
57
|
|
|
58
|
-
type MetadataTypes = 'interface' | 'class' | 'enum' | 'customobject' | 'customfield';
|
|
58
|
+
type MetadataTypes = 'interface' | 'class' | 'enum' | 'customobject' | 'customfield' | 'custommetadata';
|
|
59
59
|
|
|
60
60
|
type SourceFileMetadata = {
|
|
61
61
|
filePath: string;
|