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
Descriptions of overridden methods are missing. #1580
Comments
Forgot to mention — this case was working for me pre-0.20, I ran into the issue when attempting to upgrade. |
That's really weird... I could have sworn we had a test case for this one. |
Here's a stripped-down version of my project if it's helpful: Methods that are inherited but not overridden are displayed just fine, it's just undocumented overrides that lose descriptions. |
Thanks @Gerrit0! Unfortunately the bugfix in d5bb930 appears to fix the simple A>B>C case provided above, but not another version of the problem in the same .ZIP file above. The class inheritance hierarchy is:
|
Aww shoot, I don't think I ever even downloaded the zip. I'll have to take another look |
Shoot. This is because of reflection ordering... The fix for this requires the implements plugin keeping track of inheritance so that it doesn't do child classes before parent classes.
|
Search terms
inherit, inherited, override, overridden, missing documentation
Expected Behavior
If a parent class declares a method that is overridden by child classes, the description provided with the parent method should be shown unless a child class provides its own description.
Actual Behavior
If the child class does not provide a new method description when overriding a method, no method description is rendered in the docs.
Steps to reproduce the bug
Given a simple project...
... generate documentation with something like:
The problem occurs whether
--excludeNotDocumented
is given or not, but the flag is helpful to my project so I thought I'd call it out as an additional case here: missing documentation on a child class does not prevent the method from appearing in the docs; only the description goes missing.Despite the documenation on
A.run
above, inspectingC.run
will show no description:Environment
The text was updated successfully, but these errors were encountered: