Skip to content

feat: Add XML docs and Obsolete annotations - #308

Merged
razor-x merged 2 commits into
mainfrom
codex/add-docstring-support-in-codegen
Jul 29, 2026
Merged

feat: Add XML docs and Obsolete annotations#308
razor-x merged 2 commits into
mainfrom
codex/add-docstring-support-in-codegen

Conversation

@razor-x

@razor-x razor-x commented Jul 28, 2026

Copy link
Copy Markdown
Member

Motivation

  • Emit C# XML documentation comments and [Obsolete] attributes in generated SDK code by using schema prose and deprecation reasons so consumers get richer API docs and deprecation guidance.

Description

  • Add a documentation Handlebars partial and include it in templates to render /// <summary> XML docs and [Obsolete] attributes before classes, enums, properties, and API methods using new helpers.
  • Introduce csDoc and csString helpers in handlebars-helpers.ts to escape and format schema text for C# XML comments and string literals, and wire them into templates.
  • Extend the model builder in build-model.ts to carry documentation and obsoleteMessage fields (and richer enum value metadata via EnumValue) through normalization and class/enum/route construction so templates can render docs and deprecations; update class-model.ts types accordingly.
  • Regenerate C# output templates to include documentation everywhere (many output/csharp/src/Seam/Api/*.cs files updated accordingly).

Testing

  • Regenerated the C# SDK sources with the updated generator and verified the files were produced with XML docs and [Obsolete] annotations (diff contains many updated output/csharp files).
  • Ran the TypeScript build and tests (npm run build and npm test) for the codegen package and confirmed they succeeded with no type errors.

Codex Task

@razor-x razor-x changed the title Generate XML docs and Obsolete annotations from schema in C# codegen feat: Generate XML docs and Obsolete annotations Jul 29, 2026
@razor-x razor-x changed the title feat: Generate XML docs and Obsolete annotations feat: Add XML docs and Obsolete annotations Jul 29, 2026
@razor-x
razor-x merged commit 0dd6988 into main Jul 29, 2026
11 checks passed
@razor-x
razor-x deleted the codex/add-docstring-support-in-codegen branch July 29, 2026 00:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants