search

fsharp / fsharp-compiler-docs

Doc build for FSharp.Compiler.Service
https://fsharp.github.io/fsharp-compiler-docs
MIT License
279 stars 123 forks source link

XmlDoc vs XmlDocSig #70

Closed ovatsus closed 10 years ago

ovatsus commented 10 years ago

Hi. I'm trying to add the xml docs from typeproviders to FSharp.Formatting. I noticed that XmlDoc has content for them, but not XmlDocSig, which is what's FSharp.Formatting is using. Can someone please explain me the difference from XmlDocSig and XmlDoc in FSharpEntity?

7sharp9 commented 10 years ago

I suspect the former is the signature the compiler produces during compilation, and the latter is a lookup into an xmldoc document. In the FSB we use monodic/xml files to trawl the correct summary data for tooltips.

ovatsus commented 10 years ago

I think I got it. XmlDocSig is an index into the generated xml documentaiton file. But some things like type providers don't go into the xml documenation file, that's why xmldocsig is empty for them, but they do have content in xmldoc