Correctly grouping members within modules in JSDoc v3
JSDoc is great! It's documentation not so much.
I needed a way to logically group together global methods and I was unsuccessful in finding a straightforward way in its official documentation.
Eventually, I've come across the following method, using @module and @member.
First, we define the module name, usually at the top of the file:
We then proceed to annotate the target function with ```@memeber MyModule```.
One other important aspect is to also include ```@function``` along with the name of the function in order to appear in the module section.
* @member MyModule
* @function myFunction
export const myFunction = () => ....
28 Sep 2021
« Back to post