Emitter framework CSharp progress #7655
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
|
All changed packages have been documented.
Show changes
|
timotheeguerin
force-pushed
the
feature/ef-csharp
branch
from
63278be to
5333bec
Compare
commit: |
|
You can try these changes here
|
This pull request introduces several enhancements to the `emitter-framework` package, focusing on improved handling of documentation comments, updates to dependencies, and adjustments to test cases for better alignment with C# conventions. The most important changes include adding support for rendering doc comments in C# components, updating dependencies in `package.json`, and modifying test cases to reflect these updates. ### Enhancements to documentation handling: * [`packages/emitter-framework/src/csharp/components/utils/doc-comments.tsx`](diffhunk://#diff-087e1aeed57c139171681aa254ec8bd9ecfeebf1f1dfbae69428068224016c25R1-R59): Added a new utility function `getDocComments` to render doc strings for TypeSpec types, including support for parameter and return type documentation. * [`packages/emitter-framework/src/csharp/components/class-declaration.tsx`](diffhunk://#diff-658c1a3f2ea2971e306337f9b3c86cb81840dde47224f9a629d4614e1ab47e68R6): Integrated `getDocComments` into class declarations, properties, and methods to include documentation in the rendered C# output. [[1]](diffhunk://#diff-658c1a3f2ea2971e306337f9b3c86cb81840dde47224f9a629d4614e1ab47e68R6) [[2]](diffhunk://#diff-658c1a3f2ea2971e306337f9b3c86cb81840dde47224f9a629d4614e1ab47e68L31-R37) [[3]](diffhunk://#diff-658c1a3f2ea2971e306337f9b3c86cb81840dde47224f9a629d4614e1ab47e68R46-R57) [[4]](diffhunk://#diff-658c1a3f2ea2971e306337f9b3c86cb81840dde47224f9a629d4614e1ab47e68R74-R91) * [`packages/emitter-framework/src/csharp/components/enum-declaration.tsx`](diffhunk://#diff-aa0ae1a229f62db1a9eea50d4faf0479377289ddcd02e32bcdaf753ed166738fR6): Added support for rendering doc comments for enum members using the `getDocComments` utility. [[1]](diffhunk://#diff-aa0ae1a229f62db1a9eea50d4faf0479377289ddcd02e32bcdaf753ed166738fR6) [[2]](diffhunk://#diff-aa0ae1a229f62db1a9eea50d4faf0479377289ddcd02e32bcdaf753ed166738fR34-R54) Resolves #7680
…ture/ef-csharp
…ture/ef-csharp
…ture/ef-csharp
timotheeguerin
commented
Jun 30, 2025
timotheeguerin
requested review from
joheredi,
timovv,
qiaozha,
MaryGao,
xirzec,
bterlson,
markcowl,
witemple-msft,
chrisradek and
AlitzelMendez
as code owners
chrisradek
approved these changes
Jun 30, 2025
chrisradek
approved these changes
Jun 30, 2025
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.
Feature branch that was used to checkin features with dev version of alloy.