Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@param <T> syntax #276

Open
iansan5653 opened this issue Dec 22, 2020 · 2 comments
Open

@param <T> syntax #276

iansan5653 opened this issue Dec 22, 2020 · 2 comments

Comments

@iansan5653
Copy link

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;
}
@hosseinmd
Copy link

hosseinmd commented Mar 29, 2021

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
 */

@hosseinmd
Copy link

#72

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants