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

JSDoc Comment Template not provided when unrelated JSDoc with tag exists #52517

Closed
DanielRosenwasser opened this issue Jan 30, 2023 · 1 comment · Fixed by #54132
Closed

JSDoc Comment Template not provided when unrelated JSDoc with tag exists #52517

DanielRosenwasser opened this issue Jan 30, 2023 · 1 comment · Fixed by #54132
Labels
Domain: JSDoc Relates to JSDoc parsing and type generation Experience Enhancement Noncontroversial enhancements Help Wanted You can do this Suggestion An idea for TypeScript
Milestone

Comments

@DanielRosenwasser
Copy link
Member

JSDoc comment templates don't work if you have a preceding JSDoc comment declared using a @typedef or an @overload tag.

/** @typedef {string} Id */

/**$ */
function foo(x, y, z) {
}

Request docCommentTemplate.

The following is expected:

/** @typedef {string} Id */

/**
 * 
 * @param x 
 * @param y 
 * @param z 
 */
function foo(x, y, z) {
}

But instead we get:

/** @typedef {string} Id */

/**
 * 
 */
function foo(x, y, z) {
}

Originally posted by @DanielRosenwasser in #52370 (comment)

@RyanCavanaugh RyanCavanaugh added Suggestion An idea for TypeScript Help Wanted You can do this Domain: JSDoc Relates to JSDoc parsing and type generation Experience Enhancement Noncontroversial enhancements labels Feb 3, 2023
@RyanCavanaugh RyanCavanaugh added this to the Backlog milestone Feb 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Domain: JSDoc Relates to JSDoc parsing and type generation Experience Enhancement Noncontroversial enhancements Help Wanted You can do this Suggestion An idea for TypeScript
Projects
None yet
3 participants