Skip to content

Commit 7fa284c

Browse files
committed
Enhance LWC documentation handling by filtering exposed components and updating related metadata checks
1 parent 3bb778b commit 7fa284c

File tree

7 files changed

+756
-26
lines changed

7 files changed

+756
-26
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -337,6 +337,15 @@ Then you only need to run the top level `apexdocs` command, and it will generate
337337
Note that you can still run the individual commands if you only want to generate one type of documentation by
338338
providing the subcommand, e.g `apexdocs markdown` or `apexdocs changelog`.
339339

340+
### LWC Documentation Limitations
341+
342+
ApexDocs supports generating documentation for Lightning Web Components (LWC) as well, but please
343+
be aware of the following limitations:
344+
345+
* Only components marked as `isExposed=true` in the component's meta.xml file will be documented.
346+
* At the moment, any JSDoc comments are ignored, documentation is based solely on the component's metadata.
347+
* Changelog generation does not include changes to LWCs.
348+
340349
### Excluding Files from Being Documented
341350

342351
Any pattern included in the `.forceignore` file will be excluded from the documentation.

0 commit comments

Comments
 (0)