tsdoc
tsdoc copied to clipboard
@param <T> syntax
Is @param <T> - description a valid alternative for @typeParam T - description? It's marked as invalid in the playground but is provided as an example in the docs:
/**
* Wrapper for an HTTP Response
* @typeParam B - Response body
* @param <H> - Headers
*/
interface HttpResponse<B, H> {
body: B;
headers: H;
statusCode: number;
}
IMO tsdoc should not change standard of jsdoc which supported anywhere like VS Code. That example should be changed to this:
/**
* Wrapper for an HTTP Response
* @template H, B
* @param {B} body - Response body
* @param {H} headers - Headers
*/
https://github.com/microsoft/tsdoc/issues/72