Try https://github.com/saucecontrol/InheritDoc

googleapis / google-cloud-dotnet

Google Cloud Client Libraries for .NET

https://cloud.google.com/dotnet/docs/reference/

Apache License 2.0

941 stars 367 forks source link

Try https://github.com/saucecontrol/InheritDoc #10685

Closed jskeet closed 1 year ago

jskeet commented 1 year ago

This was noted in https://github.com/dotnet/roslyn/issues/12485 (which I raised 7 years ago).

If https://github.com/saucecontrol/InheritDoc works it could:

Fix <inheritdoc> issues (assuming it also works with docfx)
Reduce our package sizes by trimming internal/private doc comments

jskeet commented 1 year ago

First attempt at using this appeared to have no effect at all. More investigation required.

jskeet commented 1 year ago

Ah - I'd missed that by default it's only enabled for release builds. Specifying <InheritDocEnabled>true</InheritDocEnabled> fixes that.

However, it still doesn't find the inheritance in Firestore, e.g. for GeoPoint.GetHashCode. Continuing to investigate...

jskeet commented 1 year ago

Okay, it's definitely not just going to work out of the box without significantly more investigation. This may be worth looking at eventually, but not right now.