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.

Sign up for GitHub

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

Jump to bottom

Invalid XML in documentation comments #749

Closed
1 of 4 tasks
RomainMuller opened this issue Aug 28, 2019 · 1 comment · Fixed by #772
Closed
1 of 4 tasks

Invalid XML in documentation comments #749

RomainMuller opened this issue Aug 28, 2019 · 1 comment · Fixed by #772
Assignees
@assyadh
Labels
bug This issue is a bug. language/dotnet Related to .NET bindings (C#, F#, ...) p0

Comments

@RomainMuller
Copy link
Contributor

🐛 Bug Report

Affected Languages

  • TypeScript or Javascript
  • Python
  • Java
  • .NET (C#, F#, ...)

General Information

  • JSII Version: 0.15.1
  • Platform: Darwin f01898256a91 18.7.0 Darwin Kernel Version 18.7.0: Tue Aug 20 16:57:14 PDT 2019; root:xnu-4903.271.2~2/RELEASE_X86_64 x86_64

What is the problem?

When creating documentation comments, XML-reserved characters are not correctly escaped, resulting in the literal copying of characters such as < and >, which make the documentation strings invalid for documentation website generators such as docfx.
@RomainMuller RomainMuller added bug This issue is a bug. language/dotnet Related to .NET bindings (C#, F#, ...) labels Aug 28, 2019
@RomainMuller RomainMuller added this to the .NET Support milestone Aug 28, 2019
@assyadh
Copy link
Contributor

assyadh commented Aug 28, 2019

Do you have an example of a cdk package affected?

@assyadh assyadh mentioned this issue Sep 11, 2019
Merged
@assyadh assyadh added the p0 label Sep 11, 2019
RomainMuller pushed a commit that referenced this issue Sep 18, 2019
@RomainMuller
fix(dotnet): fix deep type conversion across the process boundary, in…
ecf8d3b 
…telisense docs, set target to netcoreapp2.1 (#772)

This PR fixes various issues due to how we convert collection elements, and how the type reference is passed when converting.


These two issues are similar and are due to nested Arrays of object not being casted properly:
Fixes aws/aws-cdk#3244
Fixes aws/aws-cdk#3672
Added a unit test to cover the case

This issue is due to Maps of Arrays of Anys not being casted properly:
Fixes aws/aws-cdk#3813 
Added a unit test to cover the case

Also added support for xml documentation which is now added to the NuGet packages and should allow intellisense to provide in IDE help:
Fixes #749
Fixes aws/aws-cdk#1846

Migrated the target framework to netcoreapp2.1 instead of netstandard2.0:
Fixes #714
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@assyadh assyadh

Labels
bug This issue is a bug. language/dotnet Related to .NET bindings (C#, F#, ...) p0
Projects
None yet
Milestone
No milestone
2 participants
@RomainMuller @assyadh