Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

inheritdoc should support built-in types #5909

Closed
tdmowrer opened this issue May 14, 2020 · 2 comments
Closed

inheritdoc should support built-in types #5909

tdmowrer opened this issue May 14, 2020 · 2 comments
Labels
dotnet: xml-comment XML comment for .NET API reference docs dotnet Generate .NET API reference docs

Comments

@tdmowrer
Copy link

Operation System: (Windows or Linux or MacOS)
macOS

DocFX Version Used:
2.51

Template used: (default or statictoc or contain custom template)
default

Steps to Reproduce:

  1. Add <inheritdoc/> to a method defined in a system interface, like IEnumerable<T>.GetEnumerator or GetHashCode.
  2. Execute DocFX

Expected Behavior:
Documentation is generated.

Actual Behavior:
No documentation is generated.

This seems to be because <inheritdoc/> doesn't support system types. However, <see cref={some system type}/> does work, so DocFX seems to be capable of this.

@DanielsCode
Copy link

Hi,

we have the same problem. Are there any updates?

Cheers,
Daniel

@KalleOlaviNiemitalo
Copy link

KalleOlaviNiemitalo commented Aug 3, 2020

https://xref.docs.microsoft.com/query?uid=System.Collections.Generic.IEnumerable`1.GetEnumerator returns an object that has hrefand summary properties but does not have returns, remarks, etc.. So if inheritdoc should copy all of those, then it would have to get them from somewhere else.

There are also license concerns. If your build system embeds copyrighted material from Microsoft's xref service to your product documentation daily, and Microsoft changes the license terms some day, then how will you notice? The xref service is not like a NuGet package where you can keep fetching the old version with the old license terms.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dotnet: xml-comment XML comment for .NET API reference docs dotnet Generate .NET API reference docs
Projects
None yet
Development

No branches or pull requests

4 participants