Skip to content

Commit e577f7e

Browse files
committed
Add deprecated comment
1 parent 61e16d4 commit e577f7e

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

src/compiler/factoryPublic.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2487,6 +2487,9 @@ namespace ts {
24872487
return tag;
24882488
}
24892489

2490+
/**
2491+
* @deprecated Use `createJSDocParameterTag` to create jsDoc param tag.
2492+
*/
24902493
export function createJSDocParamTag(name: EntityName, isBracketed: boolean, typeExpression?: JSDocTypeExpression, comment?: string): JSDocParameterTag {
24912494
const tag = createJSDocTag<JSDocParameterTag>(SyntaxKind.JSDocParameterTag, "param", comment);
24922495
tag.typeExpression = typeExpression;
@@ -2581,7 +2584,7 @@ namespace ts {
25812584
return tag;
25822585
}
25832586

2584-
export function createJSDocImplementTag(classExpression: JSDocImplementsTag["class"], comment?: string) {
2587+
export function createJSDocImplementsTag(classExpression: JSDocImplementsTag["class"], comment?: string) {
25852588
const tag = createJSDocTag<JSDocImplementsTag>(SyntaxKind.JSDocImplementsTag, "implements", comment);
25862589
tag.class = classExpression;
25872590
return tag;

tests/baselines/reference/api/tsserverlibrary.d.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4250,6 +4250,9 @@ declare namespace ts {
42504250
function createJSDocTypeTag(typeExpression: JSDocTypeExpression, comment?: string): JSDocTypeTag;
42514251
function createJSDocReturnTag(typeExpression?: JSDocTypeExpression, comment?: string): JSDocReturnTag;
42524252
function createJSDocThisTag(typeExpression?: JSDocTypeExpression): JSDocThisTag;
4253+
/**
4254+
* @deprecated Use `createJSDocParameterTag` to create jsDoc param tag.
4255+
*/
42534256
function createJSDocParamTag(name: EntityName, isBracketed: boolean, typeExpression?: JSDocTypeExpression, comment?: string): JSDocParameterTag;
42544257
function createJSDocClassTag(comment?: string): JSDocClassTag;
42554258
function createJSDocComment(comment?: string | undefined, tags?: NodeArray<JSDocTag> | undefined): JSDoc;
@@ -4263,7 +4266,7 @@ declare namespace ts {
42634266
function createJSDocPropertyTag(typeExpression: JSDocTypeExpression | undefined, name: EntityName, isNameFirst: boolean, isBracketed: boolean, comment?: string): JSDocPropertyTag;
42644267
function createJSDocParameterTag(typeExpression: JSDocTypeExpression | undefined, name: EntityName, isNameFirst: boolean, isBracketed: boolean, comment?: string): JSDocParameterTag;
42654268
function createJSDocTypeLiteral(jsDocPropertyTags?: readonly JSDocPropertyLikeTag[], isArrayType?: boolean): JSDocTypeLiteral;
4266-
function createJSDocImplementTag(classExpression: JSDocImplementsTag["class"], comment?: string): JSDocImplementsTag;
4269+
function createJSDocImplementsTag(classExpression: JSDocImplementsTag["class"], comment?: string): JSDocImplementsTag;
42674270
function createJSDocAuthorTag(comment?: string): JSDocTag;
42684271
function createJSDocPublicTag(): JSDocTag;
42694272
function createJSDocPrivateTag(): JSDocTag;

tests/baselines/reference/api/typescript.d.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4250,6 +4250,9 @@ declare namespace ts {
42504250
function createJSDocTypeTag(typeExpression: JSDocTypeExpression, comment?: string): JSDocTypeTag;
42514251
function createJSDocReturnTag(typeExpression?: JSDocTypeExpression, comment?: string): JSDocReturnTag;
42524252
function createJSDocThisTag(typeExpression?: JSDocTypeExpression): JSDocThisTag;
4253+
/**
4254+
* @deprecated Use `createJSDocParameterTag` to create jsDoc param tag.
4255+
*/
42534256
function createJSDocParamTag(name: EntityName, isBracketed: boolean, typeExpression?: JSDocTypeExpression, comment?: string): JSDocParameterTag;
42544257
function createJSDocClassTag(comment?: string): JSDocClassTag;
42554258
function createJSDocComment(comment?: string | undefined, tags?: NodeArray<JSDocTag> | undefined): JSDoc;
@@ -4263,7 +4266,7 @@ declare namespace ts {
42634266
function createJSDocPropertyTag(typeExpression: JSDocTypeExpression | undefined, name: EntityName, isNameFirst: boolean, isBracketed: boolean, comment?: string): JSDocPropertyTag;
42644267
function createJSDocParameterTag(typeExpression: JSDocTypeExpression | undefined, name: EntityName, isNameFirst: boolean, isBracketed: boolean, comment?: string): JSDocParameterTag;
42654268
function createJSDocTypeLiteral(jsDocPropertyTags?: readonly JSDocPropertyLikeTag[], isArrayType?: boolean): JSDocTypeLiteral;
4266-
function createJSDocImplementTag(classExpression: JSDocImplementsTag["class"], comment?: string): JSDocImplementsTag;
4269+
function createJSDocImplementsTag(classExpression: JSDocImplementsTag["class"], comment?: string): JSDocImplementsTag;
42674270
function createJSDocAuthorTag(comment?: string): JSDocTag;
42684271
function createJSDocPublicTag(): JSDocTag;
42694272
function createJSDocPrivateTag(): JSDocTag;

0 commit comments

Comments
 (0)