Pete Gonzalez

The quick answer is that the TSDoc parser library does not yet support Markdown links at all. Probably it would be counterintuitive not to, however I would hesitate to mix...

@willingc I have some questions about this: If you specify `[link text](/url-path)` how would a documentation engine process this link, since it's not an absolute URL? In our system, the...

Here's an example of a TypeScript generator: ```ts /** * - yields numbers * - returns strings * - can be passed in booleans */ function* counter(): Generator { let...

From the [JSDoc manual](https://jsdoc.app/tags-yields.html), it seems the above API would get documented like this: ```ts // JSDoc example /** * @yields {number} increasing integer values; the final value is the...

I see, so you are proposing that `@returns` documents the final `DONE!` value from my example, whereas `@yields` documents the individual iterator results. Would there be a way to document...

> I see, so you are proposing that `@returns` documents the final `DONE!` value from my example, whereas `@yields` documents the individual iterator results. BTW this does /not/ seem to...

Why do you need to specify the type using `{` `}`? Isn't it already captured in the TypeScript type signature for the function?

I see. So based on this discussion, could someone propose a spec for `@yields`? (A concise statement of the allowed syntax variations, what they mean, and some usage examples.) Then...

Hmm... you might be right. I had not gotten around to tuning perf yet. The main idea was to abstract the string building, so that if some technique is found...

In TypeScript, types are specified using in the language itself. It doesn't make sense to declare them in the comment. When people are writing new TypeScript code using TSDoc, it's...