question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Swashbuckle doesn't work properly with inheritdoc

See original GitHub issue

I have following xmldoc generated:

<member name="P:Gate.GateConfig.Connection"> <inheritdoc /> </member> And this member is inherited from an interface. Visual Studio shows this properly, but output swagger is generated without information from parent.

Issue Analytics

  • State:open
  • Created 7 years ago
  • Reactions:45
  • Comments:18

github_iconTop GitHub Comments

11reactions
julealgoncommented, Mar 25, 2021

Are there are news here? It’s been over 4 years this has been opened.

I got into this situation today as well while doing some cleanup on some of our models. We have an interface defining a few properties that many DTOs have and changed the classes to use <inheritdoc /> only to find that the text vanished from the schema.

8reactions
Kikimoracommented, Mar 13, 2019

In the meantime this is how you can workaround the problem

  1. dotnet tool -g install InheritDoc
  2. Add this target to your csproj file and also
  <Target Name="InheritDoc" AfterTargets="PostBuildEvent" Condition="$(GenerateDocumentationFile)">
    <Exec Command="InheritDoc -o" IgnoreExitCode="True" ContinueOnError="true"/>
  </Target>
Read more comments on GitHub >

github_iconTop Results From Across the Web

Swashbuckle doesn't work properly with inheritdoc #1000
I have following xmldoc generated: And this member is inherited from an interface. Visual Studio shows this properly, but output swagger is ...
Read more >
ASP.NET Core with Swashbuckle using inheritance and ...
I am working on an ASP.NET Core REST controller that uses Swashbuckle. My API response models use inheritance, and have associated ...
Read more >
Swashbuckle doesn't work properly with inheritdoc
And this member is inherited from an interface. Visual Studio shows this properly, but output swagger is generated without information from ...
Read more >
Unchase.Swashbuckle.AspNetCore.Extensions
This method gets called by the runtime. Use this method to add services to the container. public void ConfigureServices(IServiceCollection services) ...
Read more >
Using the <inheritdoc /> Tag
The use of the tag by itself on a member is enough to satisfy the compiler so that it will not issue warnings...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found