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

No documentation in intellisense when using CDK for .NET #1846

Closed
mabead opened this issue Feb 24, 2019 · 5 comments · Fixed by aws/jsii#772
Closed

No documentation in intellisense when using CDK for .NET #1846

mabead opened this issue Feb 24, 2019 · 5 comments · Fixed by aws/jsii#772
Assignees
@costleya
Labels
effort/small Small work item – less than a day of effort language/dotnet Related to .NET bindings p0

Comments

@mabead
Copy link

mabead commented Feb 24, 2019

When I use the CDK in TypeScript, I get the documentation directly in the IDE:

image

But when I use the CDK in .NET, I have no documentation in my IDE:

image

Could you please include the documentation in the xml doc of the CDK nuget packages so that it is displayed in the IDE?

Thanks!
@eladb eladb added the language/dotnet Related to .NET bindings label Feb 24, 2019
@eladb
Copy link
Contributor

eladb commented Feb 24, 2019

@costleya

@costleya
Copy link
Contributor

We can definitely do this when we start doing some work on the generator. We'll try to schedule to do this work sometime in April or May.

@fulghum fulghum added the p0 label Apr 2, 2019
@fulghum
Copy link
Contributor

fulghum commented Apr 2, 2019

This just requires updating the .NET generator to include the documentation in NDoc format, right? Or is there more involved (like building/shipping a doc archive)?

@fulghum fulghum added the effort/small Small work item – less than a day of effort label Apr 22, 2019
@costleya
Copy link
Contributor

I have spoken with the team. We are working on a fix.

@assyadh
Copy link
Contributor

assyadh commented Sep 17, 2019

Will be fixed by aws/jsii#772

@assyadh assyadh mentioned this issue Sep 17, 2019
Merged
RomainMuller pushed a commit to aws/jsii 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

@costleya costleya

Labels
effort/small Small work item – less than a day of effort language/dotnet Related to .NET bindings p0
Projects
None yet
Milestone
No milestone
5 participants
@fulghum @eladb @costleya @assyadh @mabead