After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 699732 - Inconsistent exception documentation format
Inconsistent exception documentation format
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: build
1.8.3.1
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
: 699782 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2013-05-06 00:03 UTC by Leo Carreon
Modified: 2013-05-19 12:36 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Zip file containing doxygen config file and resulting pdf file (116.17 KB, application/x-zip-compressed)
2013-05-06 21:33 UTC, Leo Carreon
Details
Source files used to produce pdf file (4.58 KB, application/x-gzip-compressed)
2013-05-06 21:35 UTC, Leo Carreon
Details

Description Leo Carreon 2013-05-06 00:03:24 UTC
I am building my documentation on Fedora 18 which results into a PDF file.  I have noticed that the format of exception documentation in the resulting PDF file is inconsistent.  It appears that the intention was to enclose the exceptions in a box but all exception boxes are incomplete.  Some boxes are missing the left and top border while others are missing the left border only.  (Please see the attached PDF file.)
Comment 1 albert 2013-05-06 18:15:27 UTC
Thank you for reporting this problem, but can you please attach the promised attachment as well as the used configuration file (Doxyfile).
When possible please make a small self contained example and add this as an attachment so it is possible to reproduce the problem.
Comment 2 Leo Carreon 2013-05-06 20:53:05 UTC
Sorry, my original attachment was rejected due to its size.  I will try to reproduce the problem with a smaller set of files and will supply the attachments then.
Comment 3 Leo Carreon 2013-05-06 21:33:20 UTC
Created attachment 243425 [details]
Zip file containing doxygen config file and resulting pdf file
Comment 4 Leo Carreon 2013-05-06 21:35:16 UTC
Created attachment 243426 [details]
Source files used to produce pdf file
Comment 5 albert 2013-05-08 17:51:21 UTC
I had a look in the generated tex files and there are different environments defined for "Parameters", Template Parameters", "Exceptions". This is OK so different appearances can be created. When using for "Template Parameters" the same environment as for "Parameters" (DoxyTemplParams and DoxyParams) the results look OK.
This bug is more or less identical to bug_699782.
Comment 6 Dimitri van Heesch 2013-05-10 11:49:03 UTC
Have you tried to zoom in on the PDF, and does that make the lines magically re-appear? In that case you are looking at a PDF rendering issue. The lines are thin, and your PDF viewer does a bad job of rendering them...
Comment 7 Dimitri van Heesch 2013-05-10 11:59:14 UTC
*** Bug 699782 has been marked as a duplicate of this bug. ***
Comment 8 Dimitri van Heesch 2013-05-10 12:04:12 UTC
I see that for DoxyExceptions and DoxyTemplParams the lines of the boxes were rendered with a gray color and the other boxes (for parameters and return values) had a black color, so that may explain the differences in rendering. 

I'll render everything in the same color (black). 

Put please confirm that zooming in will make the lines of the boxes to reappear.
Comment 9 albert 2013-05-10 17:00:09 UTC
When zooming in at some moments the lines do reappear but also disappear again.
Comment 10 Leo Carreon 2013-05-10 20:09:49 UTC
OK, I am confirming that zooming in actually make the borders of exception tables and template tables re-appear.  You will probably say that this is not a bug therefore I have no objection if you wish to close it.
Comment 11 albert 2013-05-12 17:57:09 UTC
Looked at the results with SVN version 848 (Doxygen 1.8.3.1 20130512) and found on page 75 still a problem.

At the same time I think that the extra space between the word Parameters and the top of the table is a bit large, especially when we compare it with other table items (like Exceptions, Template parameters, return values).
Comment 12 albert 2013-05-12 17:59:10 UTC
Oops I added comment with wrong bug report. This problem looks like to be solved. Boxes are shown and remain whilst zooming.
Comment 13 Dimitri van Heesch 2013-05-19 12:36:05 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.4. 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.