SwaggerGenOptions.IncludeXmlComments does not support /// <inheritdoc />

[Sour-Codes]

To replicate:

1. Create a new ASP.NET Core Web API project.

dotnet new webapi

2. Set <GenerateDocumentationFile> to true in .csproj.

3. In Program.cs, replace builder.Services.AddSwaggerGen(); with:

builder.Services.AddSwaggerGen(
    swaggerGenConfiguration =>
    {
        var assembly = System
            .Reflection
            .Assembly
            .GetExecutingAssembly()
            ;
        var assemblyName = assembly
            .GetName()
            .Name
            ;
        var xmlFile = $"{assemblyName}.xml";
        var xmlPath = Path.Combine(
            AppContext.BaseDirectory,
            xmlFile
        );

        swaggerGenConfiguration.IncludeXmlComments(
            xmlPath
        );
    }
);

4. Insert the following before [HttpGet(Name = "GetWeatherForecast")]:

/// <summary>
///     This is my XML documentation comment!
/// </summary>

5. Modify [HttpGet(Name = "GetWeatherForecast")] with the following:

[HttpGet("GetWeatherForecast")]

6. Create a new type that extends WeatherForecastController, such as:

/// <summary>
///     Extends <see cref="WeatherForecastController" />.
/// </summary>
public class WeatherForecastController2
    : WeatherForecastController
{
    /// <summary>
    ///     Create a new instance.
    /// </summary>
    /// <param name="logger">
    ///     The logger.
    /// </param>
    public WeatherForecastController2(
        ILogger<WeatherForecastController> logger
    )
        : base(
            logger
        )
    {

    }

    /// <inheritdoc />
    public override IEnumerable<WeatherForecast> Get()
        => base.Get();
}

7. Run the project

dotnet run

8. Navigate to Swagger UI.
9. Observe how the deriving type does not show the XML documentation comment with the action.
10. Replace the XML documentation of the deriving type with the following:

/// <summary>
///     This is my XML documentation comment without inheriting from the base type!
/// </summary>

11. Run the project

dotnet run

12. Observe how the deriving type does show the replaced XML documentation comment with the action.

[songzheng45]

I switched to NSwag in the end.

[dotjpg3141]

There are some workarounds in https://github.com/domaindrivendev/Swashbuckle.WebApi/issues/1000 for ASP.NET Core

[Havunen]

FYI this is supported in DotSwashbuckle

[fprdkhti]

I still can't use inheritdoc functionality when it inherits xml document from another assembly. thanks for any help.

[Chaosflo]

Any news when this will be pushed?