jsdoc-http-plugin icon indicating copy to clipboard operation
jsdoc-http-plugin copied to clipboard

Suppress default params table for a function

Open telnet2 opened this issue 6 years ago • 1 comments

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?

image

This plugin is very useful!

telnet2 avatar Oct 18 '18 23:10 telnet2

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

vmarchaud avatar Oct 19 '18 08:10 vmarchaud