I am struggling documenting router.get calls with JSDocs. I am unable to get the documentation to display correctly on the page if I try to append it to my router call itself.
/**
* Health check
* @memberof health
*/
router.get('/happy', function(req, res) {
res.json({ "status" : "OK" });
});
To resolve it, I made the functions have names.
router.get('/happy', happy);
/**
* Health check
* @memberof health
*/
function happy(req, res) {
res.json({ "status" : "OK" });
}
This works, but I would really like to find a way to get the first method to work. Is there a way to document the first example? A keyword I can use?
I do the following in my code.
And the output is:
Screenshotif you don't put "@module moduleName" on the top of the file, jsdoc will not reference the others comments on the page because they don't have a parent @module
From a little bit of Googling, haven't actually tested.