Tweak xml docs

[osc-nseguin]

• Use the recommended tag "exception" instead of "throws"
• Format response status code list as a <list type="table">

Both of these somewhat improve the rendering of the generated comments in Visual Studio and Rider.

Before (Rider):

After (Rider):

Before (Visual Studio):

After (Visual Studio):

The generated code is a little uglier due to the flat nested XML. One could avoid this by refactoring the string builder utility methods.

[christianhelle]

@osc-nseguin Thanks for taking the time to improve this feature! Based on the screenshots, this is really cool!

[christianhelle]

@all-contributors please add @osc-nseguin for code

[allcontributors]

@christianhelle

I've put up a pull request to add @osc-nseguin! 🎉

[christianhelle]

@osc-nseguin The tests are unfortunately failing. Do you mind updating XmlDocumentationGeneratorTests? There are a couple of asserts there that check that the generated code contains the string <throws cref=\"ApiException\">, and this is no longer valid with your changes

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[christianhelle]

@osc-nseguin The tests are unfortunately failing. Do you mind updating XmlDocumentationGeneratorTests? There are a couple of asserts there that check that the generated code contains the string <throws cref=\"ApiException\">, and this is no longer valid with your changes

Sorry, I got a bit impatient and pushed the fixes myself 😄

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.34%. Comparing base (0b3e451) to head (0cac175).
Report is 30 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #332      +/-   ##
==========================================
+ Coverage   97.33%   97.34%   +0.01%     
==========================================
  Files          63       63              
  Lines        2402     2412      +10     
==========================================
+ Hits         2338     2348      +10     
  Misses         40       40              
  Partials       24       24              

Flag	Coverage Δ
unittests	97.34% <100.00%> (+0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.