dotnet / maintenance-packages

Repository that hosts packages from the .NET platform whose original home/branch is not building any longer.
MIT License
22 stars 10 forks source link

Allow using GenerateDocumentationFile to produce docs from triple slash instead of using the commited xml file #155

Closed carlossanlop closed 2 weeks ago

carlossanlop commented 2 weeks ago

With this change, we can add new assemblies that can opt-in to using triple slash comments as source of truth, instead of a checked-in xml file, by simply setting GenerateDocumentationFile to true in the csproj.

I tested building and packaging using the temporary commit (will revert it before merging).

I confirmed that the xml for System.Buffers is generated and it is used instead of the commited file. I could find the generated xml in these 3 locations:

ericstj commented 2 weeks ago

LGTM: In addition to answering Viktor's question - make sure you add to your documentation PR the two options for documentation.

carlossanlop commented 2 weeks ago

LGTM: In addition to answering Viktor's question - make sure you add to your documentation PR the two options for documentation.

Thanks! Question answered, and I added a TODO reminder in the documentation PR.

carlossanlop commented 2 weeks ago

The test commit has been reverted, it was just to show how I tested it.