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 comments are incorrectly downleveled #71

Open
ImRodry opened this issue Mar 20, 2022 · 0 comments
Open

JSDoc comments are incorrectly downleveled #71

ImRodry opened this issue Mar 20, 2022 · 0 comments

Comments

@ImRodry
Copy link

ImRodry commented Mar 20, 2022

I recently came across an issue with this package where JSDoc comments in getters would get incorrectly downleveled and become regular multi-line comments, which lose all the properties of a JSDoc comment. Here's an example of that taken from the bson package

declare class ObjectId {
	/**
	 * The generation time of this ObjectId instance
	 * @deprecated Please use getTimestamp / createFromTime which returns an int32 epoch
	 */
	get generationTime(): number;
	set generationTime(value: number);
}

becomes

declare class ObjectId {
	/*
	* The generation time of this ObjectId instance
	* @deprecated Please use getTimestamp / createFromTime which returns an int32 epoch
	*/
	generationTime: number;
}
@ImRodry ImRodry changed the title JSDocs are incorrectly downleveled JSDoc comments are incorrectly downleveled Mar 20, 2022
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

1 participant