BRIKEV / express-jsdoc-swagger

Swagger OpenAPI 3.x generator
https://brikev.github.io/express-jsdoc-swagger-docs/#/
MIT License
218 stars 30 forks source link

Support @ start symbol in property definition #261

Open PanGan21 opened 8 months ago

PanGan21 commented 8 months ago

Is your feature request related to a problem? Please describe. When using the express-jsdoc-swagger library, the @context property in the @property tag of a JSDoc typedef is not properly recognized, and it appears as null in the generated Swagger documentation.

Describe the solution you'd like I would like the @contextproperty to be correctly recognized and displayed in the Swagger documentation when defined in the @property tag of a JSDoc typedef.

Describe alternatives you've considered One alternative is to define all properties that start with special symbol using an escape or special symbol.

Additional context This issue affects the accuracy and completeness of the generated Swagger documentation, as it fails to properly represent the structure of the data defined in the JSDoc comments. My example use case is service a DID document as a part of did:web. Reference: https://w3c-ccg.github.io/did-method-web/#example-example-did-web-did-document-using-json-web-keys