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

DocFX doesn't resolve inheritdocs for external interfaces #6995

Closed
smaillet opened this issue Jan 18, 2021 · 5 comments
Closed

DocFX doesn't resolve inheritdocs for external interfaces #6995

smaillet opened this issue Jan 18, 2021 · 5 comments
Labels
dotnet: xml-comment XML comment for .NET API reference docs dotnet Generate .NET API reference docs
Milestone

Comments

@smaillet
Copy link

Operating System: Windows

DocFX Version Used:
2.56.6

Template used: custom template

Steps to Reproduce:

  1. Addd xrefservice to the docfx.json as described in docfx doc site
  2. on a type implementing IDisposable add the /// <inheritdoc/> comment to the Dispose() Method
  3. Build docs

Expected Behavior:
Docs would resolve the inheritdocs comment to the official docs for IDispose.Dispose() without errors or warnings

Actual Behavior:
[21-01-17 11:30:05.020]Warning:[MetadataCommand.ExtractMetadata](foo.cs#L50)Could not resolve base documentation for 'Foo.Bar.Dispose'

NOTE: The xrefservice URL for IDispose.Dispose does work and retrieves the information, so it's not like the data is missing from the service. It appears that docfx, just can't resolve inheritdocs when the docs are inherited from an external interface. (Which is quite a common thing)

smaillet added a commit to smaillet/Llvm.NET that referenced this issue Jan 18, 2021
* Bump version to RC status
* Lot's of updates to doc comments to work around yet another [DocFX bug](dotnet/docfx#6995)
smaillet added a commit to UbiquityDotNET/Llvm.NET that referenced this issue Jan 18, 2021
* Bump version to RC status
* Lot's of updates to doc comments to work around yet another [DocFX bug](dotnet/docfx#6995)
dotMorten added a commit to dotMorten/NmeaParser that referenced this issue Mar 10, 2021
@peache85
Copy link

peache85 commented Dec 1, 2021

Any new about this issue ?

@MrDave1999
Copy link

Any news on this issue? I have the same problem...

@mikernet
Copy link
Contributor

As well as external base classes.

@arnonax-tr
Copy link

Any news or at least a workaround? (other than copy/paste the original docs...)

@Crono1981
Copy link

I'm using 2.59.4 and this is still happening. :(

@yufeih yufeih added dotnet Generate .NET API reference docs dotnet: xml-comment XML comment for .NET API reference docs labels Dec 15, 2022
@yufeih yufeih added this to the Backlog milestone Mar 23, 2023
@yufeih yufeih closed this as completed Apr 4, 2023
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

7 participants