feat: Add XML docs and Obsolete annotations - #308
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
[Obsolete]attributes in generated SDK code by using schema prose and deprecation reasons so consumers get richer API docs and deprecation guidance.Description
documentationHandlebars partial and include it in templates to render/// <summary>XML docs and[Obsolete]attributes before classes, enums, properties, and API methods using new helpers.csDocandcsStringhelpers inhandlebars-helpers.tsto escape and format schema text for C# XML comments and string literals, and wire them into templates.build-model.tsto carrydocumentationandobsoleteMessagefields (and richer enum value metadata viaEnumValue) through normalization and class/enum/route construction so templates can render docs and deprecations; updateclass-model.tstypes accordingly.output/csharp/src/Seam/Api/*.csfiles updated accordingly).Testing
[Obsolete]annotations (diff contains many updatedoutput/csharpfiles).npm run buildandnpm test) for the codegen package and confirmed they succeeded with no type errors.Codex Task