Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parse @param from JSDoc (again) #2784

Open
1 task done
thw0rted opened this issue Jan 17, 2024 · 0 comments
Open
1 task done

Parse @param from JSDoc (again) #2784

thw0rted opened this issue Jan 17, 2024 · 0 comments
Labels

Comments

@thw0rted
Copy link

Is there an existing issue that is already proposing this?

  • I have searched the existing issues

Is your feature request related to a problem? Please describe it

I don't see any way to populate the description of a @Query or @Param argument to a controller method using existing JSDoc / TSDoc tags.

Describe the solution you'd like

If the JSDoc comment for a controller method includes an @param tag matching the variable with the @Query or @Param decorator, the CLI plugin should generate the corresponding @APIQuery or @APIParam decorator.

Teachability, documentation, adoption, migration strategy

No response

What is the motivation / use case for changing the behavior?

Already requested in #1695 , which was closed after https://github.com/nestjs/swagger/pull/1720/files was merged, but that added parsing for @deprecated, not @param.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant