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

Add Support for Inheritdoc #11

Open
Andrei15193 opened this issue Apr 13, 2019 · 0 comments
Open

Add Support for Inheritdoc #11

Andrei15193 opened this issue Apr 13, 2019 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@Andrei15193
Copy link
Owner

This would be a great feature because in a number of cases, the exact same documentation from a base class or implemented interface is used by the library code. Even in the same library, there are types that specialise other types, but we would like to keep the same remarks section and maybe change the summary a bit.

The inheritdoc tag should copy all the available documentation for a MemberInfo, and allow overwriting parts of it. For instance, just writing inheritdoc will copy the documentation:

/// <inheritdoc/>
public override void Method(string param1, int param2)
{
    ...
}

But if I write a summary for the method I expect to have all other documentation copied (parameters, returns, exceptions and so on.) and only have the summary updated.

/// <inheritdoc/>
/// <summary>Updated summary</summary>
public override void Method(string param1, int param2)
{
    ...
}

This feature will extend the documentation lookup because the related XML documentation file needs to be loaded for all referenced assemblies. It is possible that not all referenced assemblies will have their documentation inherited, to reduce the memory print and load time it is okay to implement this extra lookup as a lazy loaded resource from the start.

@Andrei15193 Andrei15193 added the enhancement New feature or request label Apr 13, 2019
@Andrei15193 Andrei15193 self-assigned this Jun 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant