Documentation incomplete for System.Diagnostics.DiagnosticSource and friends

[SwooshyCueb]

Issue description

Documentation for the classes in the System.Diagnostics.DiagnosticSource assembly is scant. Only bare-bones "these classes exist with these members" is present. However, XML documentation comments exists within the source.

Assuming I can motivate myself, I'd be willing to copy all the in-source documentation to this repo. Are there any tools to assist with this or is it all done more or less manually?

Target framework

Check the .NET target framework(s) being used, and include the version number(s).

• .NET Core
  • All versions
• .NET Framework
  • NuGet package exists for 4.5 and 4.6, but I assume that doesn't count.
• .NET Standard
  • NuGet package exits for 1.1, 1.3, and 2.0, but I assume that doesn't count.

[mairaw]

Thanks for pointing this out @SwooshyCueb.
@karelz can you help me get a doc build from this namespace? I can then load the existing comments into our docs.

[karelz]

@mairaw how can I help? Is there some magical tool I don't know about?

[mairaw]

@ahsonkhan maybe can help as well. Also, can I get a new version of the xml files for pipelines @davidfowl? I've noticed when I updated the extensions that we got some new APIs.

[mairaw]

You need to run the build with the flag to generate the XML documentation file. I'll make some time to get corefx working on my machine as well.

[ahsonkhan]

can you help me get a doc build from this namespace?

The attached zip has both xml files (System.Diagnostics.DiagnosticSource.xml / System.IO.Pipelines.xml).

Also, can I get a new version of the xml files for pipelines @davidfowl? I've noticed when I updated the extensions that we got some new APIs.

You probably want to cherry-pick only the new API docs from this xml since the docs and source comments are not in sync.

xml-from-source-preview4-master.zip

[mairaw]

Yes, that’s usually what I do. Thanks @ahsonkhan! I also need to finish the json PR.