I am documenting my code using jsdoc, so far so good, I have a comment like below
...
* @property {string} mode - mode of display 'video' - display video or 'audio' - play only the audio.
* @property...
and it comes in html document like
| ... | |
| mode | string | mode of display 'video' - display video or 'audio' - play only the audio.|
| ... | |
I want it to appear something like
| ... | | |
| mode | string | mode of display |
| | | 'video' - display video |
| | | 'audio' - play only the audio.|
| ... | | |
hope I am making myself clear...
for this you can simply add two line spaces instead of one for example:
this
/**
* decription
* modes:
* I am foo
* I am bar
*/
results to :
decription modes: I am foo I am bar
But
this
/**
* decription
*
* modes:
*
* I am foo
*
* I am bar
*
*/
results to :
decription
modes:
I am foo
I am bar
By using a minus
sign you can avoid <br>
(moreover not working in vscode)
/**
* @property {String} editMode editing mode
* - A: description for A
* - B: description for B
* - C: description for C
*/
getting a bullet list:
/**
* @property {String} mode mode of display
* <br> `video` - display video, or
* <br> `audio` - plays only the audio
* @property...
*/
Actual output:
You have to use br
-Tags to resolve new new lines:
mode of display <br> 'video' - display video <br> 'audio' - play only the audio.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With