C# XML Doc element `include` is not part of generated documentation

[statiqdev]

C# XML Doc element `include` is not part of generated documentation

[daveaglick]

@deap82 No, not yet - unfortunately it might be a little while. I'm working furiously on some larger-scale changes to try and get v3 out the door (follow along in the vnext branch). In order to focus on that I had to draw a line and put off other issues (otherwise it might never get done). There's a lot of good bugs and small features like this one at the top of the issue list that I'll tackle as soon as v3 is out the door.

[daveaglick]

Thanks for the bug report. This used to work (in fact, the Wyam site includes Razor documentation through an external XML file). At some point though it looks like there was a regression. My guess is that we lost the capability with a Roslyn upgrade (Wyam uses Roslyn to provide the XML comments via the compiler). I’ll dig deeper and see if I can’t restore the ability in the next release.

[deap82]

@daveaglick Any update on this?

[skini82]

@daveaglick Hi and thanks for your effort! There's a known version where this still works? I really need the XML inclusion.

[dave-sampson13]

@daveaglick Similar query, any ETA on a fix for this? We have some third-party dependencies that we want to document as part of our API documentation, but don't have the source code so are dependent on the ability to extract documentation from the assemblies &| XML comments files. Thanks!

[daveaglick]

@skini82 @dave-sampson13 Sorry folks, I don't have an ETA. Work is progressing at a fast clip on v3 (which is now called Statiq and all new development is happening there. I'm going as quick as I can, but it's probably another couple months until that reaches release and this issue is resolved.

Note that docs generated from assemblies will still pick up on compiler-generated XML documentation comments. This issue tracks the special <include> XML comment element that references an explicit XML comment file. For example, the Cake documentation downloads NuGet packages for all known addins here and then adds the resulting assemblies to the Wyam docs generation here. You can see the result, which picks up on any compiler-generated XML documentation files, at any API docs page for an addin like https://cakebuild.net/api/Cake.Dart/.