Skip to content
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

Java: final keyword on a parameter brakes docs inherinance (Origin: bugzilla #765070) #5985

Closed
doxygen opened this issue Jul 2, 2018 · 0 comments

Comments

@doxygen
Copy link
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component general for ---
Reported in version 1.8.11 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2016-04-14 20:07:16 +0000, Misha wrote:

Preface
Let's imagine we have an interface A and a class B, where B implements A.

public interface A {
/**
* Cool description.
*/
void method(int parameter);
}

public class B implements A {
@OverRide
public void method(final int parameter) {
}
}

The problem
In case 'finality' of parameters in the class doesn't match exactly 'finality' of parameters in the interface (in other words the class B marks some parameters final while the interface A doesn't or vice-versa) the class B won't inherit the docs from the interface A.

Expected result
'final' keyword used on parameters doesn't affect inheritance as it's not a part of method signature.
The class B should inherit the docs from the interface A even if there is a difference in 'finality' of parameters.

Attached:
doxygen-final.zip -- cnfig and source files that shows the problem

On 2016-04-14 20:09:52 +0000, Misha wrote:

Created attachment 326052
doxygen-final.zip

On 2016-05-07 18:00:07 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next GIT update.

On 2016-09-05 13:46:20 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.12. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

@doxygen doxygen closed this as completed Jul 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant