fsprojects / FSharp.TypeProviders.SDK

The SDK for creating F# type providers
https://fsprojects.github.io/FSharp.TypeProviders.SDK/
MIT License
298 stars 94 forks source link

Provided types documentation in other .NET languages #275

Open Liminiens opened 5 years ago

Liminiens commented 5 years ago

So far as I can understand, right now documentation from .AddXmlDoc is provided via TypeProviderXmlDoc attributes which are visible from F# projects, but not from C# project referencing the F# project with provided type. Is there a way to provide documentation for generated types which would be visible in other languages?

dsyme commented 5 years ago

THere is currently no way unfortunately.

Liminiens commented 5 years ago

Well, I made a simple extension which shows quick info with summary text from attribute, better than nothing I suppose :)

But maybe something like that could be contributed to roslyn? Or it's unlikely that they will accept such integration bits? @dsyme

sergey-tihon commented 5 years ago

@Liminiens can it be part of Ionide?

Liminiens commented 5 years ago

@sergey-tihon unfortunately I know nothing about Ionide, I usually work in VS\Rider :(