GNOME Bugzilla – Bug 494507
Java enums are partly ignored
Last modified: 2013-05-31 18:37:41 UTC
When processing Java project with several packages the enums are ignored when disabling EXTRACT_ALL (it is not reasonable in my mind to create file list in Java). When enabling EXTRACT_ALL the enums are shown only as a reference from the relevant file and they are not linked to their appearance in the method declarations or in @see tag.
Created attachment 98706 [details] Sample code and doxyfile The attachment includes /src directory with 2 packages and a /doc directory with the doxyfile
After some thinking it looks for me that the problem is that doxygen takes C/C++ approach to enum, which is not suitable for Java/C#. The main difference is that in Java/C# enum is a class!! This is reflected in teh following: - In C/C++ you cannot use the same enumerator name in 2 different enums while in Java/C# you can, in this case doxygen takes both documentations write them in both enums together. - The original bug, when you disable EXTRACT_ALL from some reason enums are not processed
I am interested in using Doxygen for my project, but I have quite a few important enum classes that I would really like to be part of the documentation. This appears to continue to be an issue in version 1.6.1. Public enums as members of a class a documented perfectly. Is there a work around for this enum as a class issue? Thanks.
I have found that if you document the package where the enum class exists, the enum will be described there evem if EXTRACT_ALL is no.
I tested with version 1.5.4 and found the behavior as described. When testing with version 1.8.4 the reference in method declaration is linked. There is no reference to MyEnum in the See also part, but this is probably due to the not fully qualified name used.
Did some further tests and the following gave hyperlinks: enums.MyEnum enums::MyEnum the first one is om java style, so I think we can set the bug to resolved.
Setting to fixed as suggested. Please reopen this bug report if you still see this issue with the latest version of doxygen. Add a self-contained example (source+config file in a zip or tar) if possible.