search

dotnet / dotnet-api-docs

.NET API reference documentation (.NET 5+, .NET Core, .NET Framework)
https://docs.microsoft.com/dotnet/api/
Other
719 stars 1.56k forks source link

Documentation for System.Reflection.Metadata (package version 1.5.0) has gone missing #3269

Open stakx opened 6 years ago

stakx commented 6 years ago

There appears to be a XML doc problem with System.Reflection.Metadata, version 1.5.0. Despite being quite thoroughly documented in the original source code, most or all of that documentation appears to get lost on its way to VS IntelliSense and the online .NET API Browser.

I checked some of the XML documentation files in the NuGet package that sits in my local NuGet package cache at C:\Users\stakx\.nuget\packages\system.reflection.metadata\1.5.0\lib\netstandard2.0\System.Reflection.Metadata.xml—it contains the markup skeleton but no actual documentation text.

mairaw commented 6 years ago

Thanks @stakx! What happens is that the IntelliSense is generated from what is in the https://github.com/dotnet/dotnet-api-docs repo, not the source code. In the future, we'll be able to do a one-time import for new classes of the /// comments. So, right now, we'll have to manually import the content from the source into our docs.

stakx commented 5 years ago

@mairaw: What is the status on importing missing reference docs? Is there anything that the community (e.g., me) can do to help? I'd like to see this one resolved.

mairaw commented 5 years ago

Thanks @stakx for your kind offer. @carlossanlop from the dev team is already helping us to bring a lot of the existing comments from the source code. You can see we have a number of PRs on the review queue right now related to that: https://github.com/dotnet/dotnet-api-docs/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+metadata+