Skip to content

Add Support for Inheritdoc #11

Description

@Andrei15193

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.

Activity

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

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions