[DocumentationEnumerator] Support global alias matching

mono / api-doc-tools

.NET Reference API Toolchain

MIT License

68 stars 48 forks source link

[DocumentationEnumerator] Support global alias matching #641

Closed pjcollins closed 2 years ago

pjcollins commented 2 years ago

The tooling is currently unable to match existing documentation with a member that was updated to include a global alias. Fix this by adding a a type lookup attempt that prefixes global:: to the documentation member name.

huangmin-ms commented 2 years ago

@pjcollins @jonpryor please let me know if a new nuget package release is needed for you to consume this change.

pjcollins commented 2 years ago

@huangmin-ms thanks! We will need a new NuGet package release with these changes, however I have a couple of other PRs that would be great to bundle with the next NuGet release if possible:

https://github.com/mono/api-doc-tools/pull/637 - I've just tried to update this to address your comment about explicit interface implementations. However, I am not familiar with the scenario that commit eb7fec62c3ec4759ae178bd601564aa4f4d66ed6 was trying to fix and am not sure if I am entirely on the right track there.
https://github.com/mono/api-doc-tools/pull/638 - Should hopefully be a straightforward change.

huangmin-ms commented 2 years ago

@pjcollins #638 is merged. #642 may also be able to catch this release. For #637 is this one urgent? Can we postpone this one to next release? I may be able to look at it sometime next week.

pjcollins commented 2 years ago

@huangmin-ms Thanks! #637 is not immediately urgent, it can wait until the next release. It may be required for us when we try to update our Android API docs from Android 12 to Android 12.1 or Android 13, which we would like to do in the coming months.

huangmin-ms commented 2 years ago

@pjcollins mdoc 5.8.9.2 is released.