-
Notifications
You must be signed in to change notification settings - Fork 14
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
Interfaces are created with "inheritdoc" xml comments #57
Comments
When I started this, i actually copied them. |
I’ll see if I succeed in doing it myself.
But as it is, I think no xml docs is better then inheritdoc.
|
It should be possible to use inheritdoc with a specific /// <inheritdoc cref="ClassName.MethodName{Generic1,Generic2}(Param1Type,Param2Type)"/> It worked for this random method I tried it on in Rider. I don't know how hard it is to write as as source generator. |
@fjmorel This appears to work, at least for Jetbrains Rider. I have submitted a PR (#63) and my initial testing seems positive. |
As interfaces are typically at the top of the inheritance chain (interface -> abstract class -> concrete class) inheriting documentation does not make sense.
In manual code, inheritdoc is often used in the concrete class, but since we generate our interface, we put the xml documentation in the class itself. Inheriting bottom up does not work, so if you want to do anything with xml comments at all, I'd suggest you simply copy them.
The text was updated successfully, but these errors were encountered: