TSDoc support by swagger plugin

I’m submitting a…

[ ] Regression 
[ ] Bug report
[x] Feature request
[ ] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

TSDoc comments are ignored.

Expected behavior

TSDoc should be parsed and by swagger plugin.

Minimal reproduction of the problem with instructions

/**
 * @description  User model
 */
class UserDTO {
  /**
   * @description  password encrypted with HS256
   */
  encryptedPassword: string;
}

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

For now, i use @nestjs/swagger to expose third-party library methods as HTTP API. This library contains a lot of DTO classes, and swagger plugin helps me to automatically handle them. But it don’t respect TSDoc. TSDoc is widely used by everybody and it’s de facto standard to provide descriptions and another meta info. Without TSDoc supports @nestjs/swagger/plugin is kinda incomplete. With TSDoc support, the plugin will cover 100% of the possible use-cases. The teams could be absolute framework-agnostic, they will be able to exhaustively describe their DTO’s in pure TS.

[dilame]

Comments introspection feature was added in the previous release https://trilon.io/blog/eliminating-redundancy-with-nestjs-cli-plugins

Thank you, fascinated feature! What about @file and @deprecated?

[kamilmysliwiec]

Comments introspection feature was added in the previous release https://trilon.io/blog/eliminating-redundancy-with-nestjs-cli-plugins