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

Generate full JSDoc for JSON types #975

Merged
merged 1 commit into from
Sep 18, 2024

Conversation

timostamm
Copy link
Member

@timostamm timostamm commented Sep 18, 2024

With the option json_types=true, we generate JSON types. The JSDoc comments for these types do not carry over the original comments from the Protobuf source, and do not include information like deprecation.

This PR changes the behavior to generate the same JSDoc comments for JSON types as for the primary types.

Closes #971.

@timostamm timostamm merged commit 88fd193 into main Sep 18, 2024
22 checks passed
@timostamm timostamm deleted the tstamm/Generate-full-JSDoc-for-JSON-types branch September 18, 2024 15:08
@timostamm timostamm mentioned this pull request Sep 18, 2024
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

Successfully merging this pull request may close these issues.

Generated JSON types should include @deprecated in doc comment like the main types
2 participants