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

Support <inheritdoc/> when generating documentation #954

Closed
jmasek opened this issue Sep 16, 2022 · 1 comment · Fixed by #972
Closed

Support <inheritdoc/> when generating documentation #954

jmasek opened this issue Sep 16, 2022 · 1 comment · Fixed by #972

Comments

@jmasek
Copy link

jmasek commented Sep 16, 2022

Product and Version Used:
Roslynator Command Line Tool version 0.3.3.0 (Roslyn version 4.2.0.0)

Steps to Reproduce:

  • Create an interface and document its methods.
  • Create a class that implements the interface and use /// <inheritdoc/> directive to use the documentation from interface.

Actual Behavior:

public interface IClient
{
    /// <summary>
    /// Sends the message to the stream
    /// </summary>
   public Task SendMessageAsync();
}

public sealed class Client: IClient
{
    /// <inheritdoc/>
    public async Task SendMessageAsync(){...}
}

No description is shown in documentation for Client:SendMessageAsync()

Expected Behavior:
https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags#inheritdoc

Description is shown in documentation for Client:SendMessageAsync()

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants