Questions tagged [jsdoc]

The tag has no usage guidance.

Filter by
Sorted by
Tagged with
2 votes
0 answers
42 views

Using jsdoc @type imports in LWC crashes page when "Debug Mode"

Is anyone successfully able to use jsdoc @type imports for LWC components? According to this guide it should be possible, but when I add @type {import ...} and NOTHING else, my the entire page crashes ...
NSjonas's user avatar
  • 10.1k
9 votes
2 answers
987 views

How to document LWC Salesforce components public variables with JSDoc?

JSDoc skips my public LWC variables. Here is an example: /** * SomePublicVarName mode - default is false. * * @type {boolean} */ @api somePublicVarName = false; If I ...
Florian G's user avatar
  • 193
1 vote
0 answers
778 views

Self documenting LWC components [closed]

I would like our lightning web components to self document on confluence. Kind of like javadocs for LWC. One idea I was thinking about was to have a nightly job that runs and uses JSDoc (https://jsdoc....
kratos's user avatar
  • 531
7 votes
2 answers
2k views

How to document Lightning Web Components (LWCs)?

Aura Component bundles can include a .auradoc file that in itself is well documented. For Lightning Web Components, the bundle is stripped down to less files which is a good thing. And the overall ...
Keith C's user avatar
  • 136k