search

vmarchaud / jsdoc-http-plugin

Document your http endpoints with JSDoc
MIT License
40 stars 10 forks source link

Suppress default params table for a function #11

Open telnet2 opened 6 years ago

telnet2 commented 6 years ago

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!

vmarchaud commented 6 years ago

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