search

AzureAD / azure-activedirectory-identitymodel-extensions-for-dotnet

IdentityModel extensions for .Net
MIT License
1.03k stars 385 forks source link

[Feature Request] use `<inheritdoc/>` for overridden members #2664

Open joegoldman2 opened 1 week ago

joegoldman2 commented 1 week ago

Overridden members (methods or properties) from a base class should not repeat all the XML documentation, but rather use <inheritdoc/> in order to avoid repetition and simplify reading.

For example: https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/blob/55cc10ea53503b129afd55734ad9e9dd8203b339/src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.cs#L474-L483

keegan-caruso commented 4 days ago

@joegoldman2 ReadToken in JsonWebTokenHandler make the comment more specific such that it is about JWTs rather than security tokens as in TokenHandler.

What would you suggest we change it to?

joegoldman2 commented 4 days ago

For each I can check the difference and keep the inherited documentation if it is more specific. Would you accept a PR per project for example?

keegan-caruso commented 3 days ago

Per project sounds great! We will accept this.