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

Fix ConvertCSharpDocs multi-line regression #1463

Merged
merged 1 commit into from
Dec 14, 2021

Conversation

lahma
Copy link
Collaborator

@lahma lahma commented Dec 14, 2021

Reverted back to old logic, added unit test, changed summary format to span multiple lines so multi-line ones don't look weird.

fixes #1462
fixes #3793

@lahma lahma changed the title Fix cshardocs multi-line regression Fix csharpdocs multi-line regression Dec 14, 2021
@lahma lahma changed the title Fix csharpdocs multi-line regression Fix ConvertCSharpDocs multi-line regression Dec 14, 2021
@RicoSuter RicoSuter merged commit b03746d into RicoSuter:master Dec 14, 2021
@RicoSuter
Copy link
Owner

It's a dangerous fix as it requires a template change (some might have custom templates).

@lahma lahma deleted the fix-csharp-docs branch December 14, 2021 19:52
@lahma
Copy link
Collaborator Author

lahma commented Dec 14, 2021

Old templates should work as-is. Now the built-in ones just add new line before and after the actual content:

/// <summary>OLD_INSERTED_DATA</summary>
/// <summary>
/// OLD_INSERTED_DATA
/// </summary>

The c# part is the sample, it just appends the same data to different valid doc comment section.

@RicoSuter
Copy link
Owner

Need to fix those in NSwag as well, right?

image

@lahma
Copy link
Collaborator Author

lahma commented Dec 14, 2021

These should work without changes, but syncing the logic of having separate line might make sense.

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.

Multiline description results in incorrect C# documentation Multiline comments generation issue
2 participants