express-jsdoc-swagger icon indicating copy to clipboard operation
express-jsdoc-swagger copied to clipboard

Support @ start symbol in property definition

Open PanGan21 opened this issue 1 year ago • 0 comments
trafficstars

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 @context property 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

PanGan21 avatar Feb 29 '24 15:02 PanGan21