Missing JSDoc description when it contains @param itself

Question

Missing JSDoc description when it contains @param itself

Closed this issue 5 months ago · 4 comments

Hey! I just tried to run ts-to-jsdoc on itself and came across this:

(it cuts off the description when encountering @param)

Another case:

Answer 1 · 2024-02-20T14:34:02.000Z

Ooh, good catch! The compiler does seem to interpret those as actual JSDoc tags so I'll take that as user error on my part :^)

Answer 2 · 2024-02-20T16:54:41.000Z

You mean it's a bug in ts-morph? TS compiler handles it correctly in a little test

Answer 3 · 2024-02-20T17:22:06.000Z

Take a look at this. If you select the FunctionDeclaration and run node.jsDoc[0] in your browser console, you'll see that "test" is interpreted as the function's description, while everything following @param is interpreted as documenting the parameter.

In other words, it's not a bug — to the compiler, the function description is just "Generate".

Answer 4 · 2024-02-21T14:15:24.000Z

Interesting, I only had a quick look at Intellisense before:

(it correctly attaches everything as a description only, no description for param)

Seems like it doesn't just rely on the TypeScript AST, at least a certain level of extra code - I couldn't figure out where exactly the extra handling happens 🤔