Skip to content

Commit 70b2a74

Browse files
cesarParracesarParra
authored
Merge pull request #289 from cesarParra/apexdocs-winter26-support
Apexdocs winter26 support
2 parents 88b2932 + d05eea6 commit 70b2a74

File tree

24 files changed

+103
-767
lines changed

24 files changed

+103
-767
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,5 @@ target/
1818
/.illuminatedCloud/
1919
**/tsconfig*.json
2020
**/*.tsbuildinfo
21+
22+
**/graphql.config.yml

‎.idea/vcs.xml‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎README.md‎

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -138,24 +138,25 @@ apexdocs changelog --previousVersionDir force-app-previous --currentVersionDir f
138138

139139
#### Flags
140140

141-
| Flag | Alias | Description | Default | Required |
142-
|-----------------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|----------|
143-
| `--sourceDir` | `-s` | The directory or directories where the source files are located. | N/A | * |
144-
| `--useSfdxProjectJson` | N/A | Read source directories from `sfdx-project.json` packageDirectories. Cannot be used with `--sourceDir`. | `false` | * |
145-
| `--sfdxProjectPath` | N/A | Path to directory containing `sfdx-project.json` (defaults to current directory). Only used with `--useSfdxProjectJson`. | `process.cwd()` | No |
146-
| `--targetDir` | `-t` | The directory where the generated files will be placed. | `docs` | No |
147-
| `--scope` | `-p` | A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. | `[global]` | No |
148-
| `--customObjectVisibility` | `-v` | Controls which custom objects are documented. Values should be separated by a space. | `[public]` | No |
149-
| `--defaultGroupName` | N/A | The default group name to use when a group is not specified. | `Miscellaneous` | No |
150-
| `--namespace` | N/A | The package namespace, if any. If provided, it will be added to the generated files. | N/A | No |
151-
| `--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 |
152-
| `--includeMetadata ` | N/A | Whether to include the file's meta.xml information: Whether it is active and the API version | `false` | No |
153-
| `--linkingStrategy` | N/A | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none` | `relative` | No |
154-
| `--customObjectsGroupName` | N/A | The name under which custom objects will be grouped in the Reference Guide | `Custom Objects` | No |
155-
| `--triggersGroupName` | N/A | The name under which triggers will be grouped in the Reference Guide | `Triggers` | No |
156-
| `--lwcGroupName` | N/A | The name under which Lightning Web Components will be grouped in the Reference Guide | `Triggers` | No |
157-
| `--includeFieldSecurityMetadata` | N/A | Whether to include the compliance category and security classification for fields in the generated files. | `false` | No |
158-
| `--includeInlineHelpTextMetadata` | N/A | Whether to include the inline help text for fields in the generated files. | `false` | No |
141+
| Flag | Alias | Description | Default | Required |
142+
|-----------------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|----------|
143+
| `--sourceDir` | `-s` | The directory or directories where the source files are located. | N/A | * |
144+
| `--useSfdxProjectJson` | N/A | Read source directories from `sfdx-project.json` packageDirectories. Cannot be used with `--sourceDir`. | `false` | * |
145+
| `--sfdxProjectPath` | N/A | Path to directory containing `sfdx-project.json` (defaults to current directory). Only used with `--useSfdxProjectJson`. | `process.cwd()` | No |
146+
| `--targetDir` | `-t` | The directory where the generated files will be placed. | `docs` | No |
147+
| `--scope` | `-p` | A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. | `[global]` | No |
148+
| `--customObjectVisibility` | `-v` | Controls which custom objects are documented. Values should be separated by a space. | `[public]` | No |
149+
| `--defaultGroupName` | N/A | The default group name to use when a group is not specified. | `Miscellaneous` | No |
150+
| `--namespace` | N/A | The package namespace, if any. If provided, it will be added to the generated files. | N/A | No |
151+
| `--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 |
152+
| `--includeMetadata ` | N/A | Whether to include the file's meta.xml information: Whether it is active and the API version | `false` | No |
153+
| `--linkingStrategy` | N/A | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none` | `relative` | No |
154+
| `--customObjectsGroupName` | N/A | The name under which custom objects will be grouped in the Reference Guide | `Custom Objects` | No |
155+
| `--triggersGroupName` | N/A | The name under which triggers will be grouped in the Reference Guide | `Triggers` | No |
156+
| `--experimentalLwcSupport` | N/A | Whether to document LWC files or not. | `false` | No |
157+
| `--lwcGroupName` | N/A | The name under which Lightning Web Components will be grouped in the Reference Guide | `Lightning Web Components` | No |
158+
| `--includeFieldSecurityMetadata` | N/A | Whether to include the compliance category and security classification for fields in the generated files. | `false` | No |
159+
| `--includeInlineHelpTextMetadata` | N/A | Whether to include the inline help text for fields in the generated files. | `false` | No |
159160

160161
> **Note:** The `*` in the Required column indicates that **one** of the source directory options must be specified:
161162
> - `--sourceDir` (single directory or array of directories)
@@ -339,6 +340,9 @@ providing the subcommand, e.g `apexdocs markdown` or `apexdocs changelog`.
339340

340341
### LWC Documentation Limitations
341342

343+
⚠️ LWC documentation is only enabled when providing the `--experimentalLwcSupport` flag or setting the
344+
`experimentalLwcSupport` property to `true` in the configuration file.
345+
342346
ApexDocs supports generating documentation for Lightning Web Components (LWC) as well, but please
343347
be aware of the following limitations:
344348

‎examples/markdown/package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
"sourceDir": "force-app",
1717
"scope": ["global", "public", "protected", "private", "namespaceaccessible"],
1818
"namespace": "ns",
19-
"sortAlphabetically": true
19+
"sortAlphabetically": true,
20+
"experimentalLwcSupport": true
2021
}
2122
}

‎examples/vitepress/docs/.vitepress/cache/deps/_metadata.json‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
{
2-
"hash": "1be9f690",
2+
"hash": "e27cc44a",
33
"configHash": "7f7b0dad",
4-
"lockfileHash": "538e5018",
5-
"browserHash": "cc0537e6",
4+
"lockfileHash": "66851dcb",
5+
"browserHash": "4e79f947",
66
"optimized": {
77
"vue": {
88
"src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
99
"file": "vue.js",
10-
"fileHash": "2b2c08f3",
10+
"fileHash": "a669ecd4",
1111
"needsInterop": false
1212
},
1313
"vitepress > @vue/devtools-api": {
1414
"src": "../../../../node_modules/@vue/devtools-api/dist/index.js",
1515
"file": "vitepress___@vue_devtools-api.js",
16-
"fileHash": "227c4111",
16+
"fileHash": "db43a49d",
1717
"needsInterop": false
1818
},
1919
"vitepress > @vueuse/core": {
2020
"src": "../../../../node_modules/@vueuse/core/index.mjs",
2121
"file": "vitepress___@vueuse_core.js",
22-
"fileHash": "bb45f4ef",
22+
"fileHash": "46684668",
2323
"needsInterop": false
2424
},
2525
"@theme/index": {
2626
"src": "../../../../node_modules/vitepress/dist/client/theme-default/index.js",
2727
"file": "@theme_index.js",
28-
"fileHash": "e6db9a93",
28+
"fileHash": "d7d94412",
2929
"needsInterop": false
3030
}
3131
},

‎examples/vitepress/docs/changelog.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ These classes are new.
1010

1111
### BaseClass
1212

13+
This is a base class.
14+
15+
{@literal some literal <script>text</script>}
1316
### MultiInheritanceClass
1417

1518
### Url

‎examples/vitepress/docs/index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@ Represents a speaker at an event.
6161

6262
### [BaseClass](miscellaneous/BaseClass)
6363

64+
This is a base class.
65+
66+
{@literal some literal <script>text</script>}
67+
6468
### [MultiInheritanceClass](miscellaneous/MultiInheritanceClass)
6569

6670
### [ParentInterface](miscellaneous/ParentInterface)

‎examples/vitepress/docs/miscellaneous/BaseClass.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,22 @@ title: BaseClass
55
# BaseClass Class
66
`abstract`
77

8+
This is a base class.
9+
10+
{@literal some literal <script>text</script>}
11+
812
## Namespace
913
apexdocs
1014

15+
## Example
16+
```apex
17+
public class DerivedClass extends BaseClass {
18+
public void sampleMethod() {
19+
// Implementation here
20+
}
21+
}
22+
```
23+
1124
## Fields
1225
### `sampleEnumFromBase`
1326

‎examples/vitepress/docs/miscellaneous/SampleException.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: SampleException
66

77
This is a sample exception.
88

9-
**Usage**
9+
**Usage**
1010

1111
You can use the exception the following way.
1212
You can also take a look at [SampleClass](../samplegroup/SampleClass) to see how it is used.

‎examples/vitepress/docs/miscellaneous/SampleInterface.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: SampleInterface
88

99
This is a sample interface
1010

11-
**Mermaid**
11+
**Mermaid**
1212

1313
graph TD
1414
A[SampleInterface] -->|extends| B[ParentInterface]
@@ -40,15 +40,15 @@ sampleInterface.sampleMethod();
4040

4141
This is a sample method
4242

43-
**Custom Tag**
43+
**Custom Tag**
4444

4545
This is a custom tag
4646

47-
**Another Custom Tag**
47+
**Another Custom Tag**
4848

4949
This is another custom tag
5050

51-
**Mermaid**
51+
**Mermaid**
5252

5353
graph TD
5454
A[SampleInterface] -->|extends| B[ParentInterface]

0 commit comments

Comments
 (0)