jsdoc-http-plugin
jsdoc-http-plugin copied to clipboard
Suppress default params table for a function
I have a following code piece documented.
/**
* Requires `customerOrderId` and `role` parameters.
* @path {PUT} /eta/update/:customerOrder/:role
* @params :customerOrderId
* @params :role
*/
static async updateTimer(req, res)
I really like the output of parameters related to HTTP routing. However, I would like to suppress the parameters section, which is in fact not relevant to the function signature. Is there such an option?
This plugin is very useful!
I don't believe it's possible because @params
are used by the standard JSDoc also and we cannot override this behavior. You could however make a script that remove them from your docs with some regex i believe