JSDoc generation about orval HOT 8 CLOSED

Added with the 6.0.0. You can try it now with orval@next

from orval.

I close the issue leave me a comment if you have any problem

from orval.

Should the JSDoc comments be on just the generated schemas or the generated functions too? Currently, I only get comments on the schemas using orval 6.1.1.

from orval.

True will look to add it too

from orval.

This is mostly working for me now but I'm getting one issue. The descriptions in my OpenAPI use markdown for some formatting (which is generally supported in JS/TSDoc). This causes an issue when character combinations turn out to also be a closing comment **/.

E.g.

/**
 * Uploads a dataset.

Dataset file-naming is strictly limited to a fixed set of extensions based on the Dataset **Type**. 
You can obtain the supported types (and their extensions) via the **/type** endpoint. 
Filenames that do not comply with the supported filename extensions will be rejected.

...

It sounds like some sanitation is needed for the JSDoc just to parse out these. I think a way to do this would be a regex that looks for **/ in the string and replaces it with **\/. This appears to be at least ok in

• VSCode
• The TSDoc playground

as the added backslash is not displayed in either the generated doc.

from orval.

Hello @OliverDudgeon, thanks for reporting the bug. Do you try to fix it by yourself or do want me to do it?

from orval.

I've had a go

from orval.

Fixed with 6.2.1. thanks 🎉

from orval.