EnableCors, DisableCors: Attribute classes shouldn't have <inheritdocs> in their class XML-comments
- Dominant language
- C#
- Stars
- 38.4k
- Forks
- 10.9k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 281
Description
first, sorry, I didn't find a matching issue template, since this really isn't a bug nor a behaviour problem, but an IDE integration one - it's _maybe_ a documentation issue, but you don't have a template for that :-(
now: i intended to find out what the EnableCorsAttribtue does in VS, and VS showed me the docs for the base type, which is Attribute, which is not helpful at all.
The reason is that there's a
```cs
///
```
above the class definition.
- this is also the case for DisableCorsAttribute, btw -
also, specific for those two attributes, the documentation over at
https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.cors.enablecorsattribute?view=aspnetcore-9.0
just writes the summary of the shared interface - which while a little more specific is wrong, since those classes a) aren't interfaces and b) have specific _meaning_ which should be a) in the docs and b) in the xmlcomment.
so i suggest that someone writes some explanation there.
also, maybe, a policy should be made that prevents for each Attribute subclass - they are just not useful.
thanks, sorry if this means additional work, but i think it might be worth the effort.
Contributor guide
Assessment
This issue has not been assessed yet.