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: Annotations with brackets prevent documentation (Origin: bugzilla #737444) #5643

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

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

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

Original attachment names and IDs:

On 2014-09-26 15:11:45 +0000, starfury wrote:

Created attachment 287173
Contains a sample eclipse project with source, doxyfile and generated html output and doxygen console output

Hi!

-- PRELUDE --
I'm new to Doxygen, installed 1.8.8 only on monday trying to create documenation of my Java project.
Unfortunately I almost instantly came across a problem which seems to be a bug. Or I just wasn't able to find a documented solution. Please forgive me if the latter is the case, and thanks for any hints.
I already wrote a post on the forum/mailing list but got no response so far:
http://doxygen.10944.n7.nabble.com/Java-Annotations-prevent-Doxygen-from-documenting-class-completely-td6802.html

-- PROBLEM --
Symptom # 1
If a class is annotated with an annotation with brackets (e.g. because it takes arguments) then this class is missing in the generated class reference (although the file is listed in the file list).
@SuppressWarnings("javadoc")
public class ADoxygenTest { ... }

Symptom # 2
If a method in class is annotated with an annotation with brackets (e.g. because it takes arguments) then everything in this class from the annotated method on is missing in the generated class reference. So the class is only documented partially.
@SuppressWarnings("javadoc")
public void noop() { /* this method is not in the Doxygen output */ ... }

It seems that only the brackets are problematic, since "@deprecated" is no problem but "@deprecated()" breaks doxygen/the parser(?).

Attached you find a zip archive containing a sample java project with doxyfile to reproduce the problem as well as the html documentation generated on my machine and the doxygen console output.

-- Other References --
I should also reference this other forum/mailing list post describing a similar problem but with Java Generics:
http://doxygen.10944.n7.nabble.com/Possible-bug-while-producing-documentation-of-java-method-which-uses-generics-tp6781.html

On 2014-09-30 15:36:39 +0000, Barry wrote:

I can also confirm experiencing this bug with Doxygen 1.8.8.

If I build Doxygen from the Sourceforge trunk (V1.8.4 it seems), then the problem does not occur, and the class is fully documented.

Something between these versions has introduced the bug.

Will update further if I find out more.

On 2014-10-11 15:08:49 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next GIT update.

On 2014-10-15 07:55:49 +0000, Barry wrote:

(In reply to comment # 2)

Confirmed. Should be fixed in the next GIT update.

Rebuilt doxygen.exe from latest GitHub snapshot on 14th October, now seems to be working fine.

Many thanks Dimitri.

On 2014-12-25 16:02:53 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.9. 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 (preferrably in the form of a self-contained example).

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment