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

Inconsistent exception documentation format (Origin: bugzilla #699732) #5164

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 normal in component build for ---
Reported in version 1.8.3.1 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2013-05-06 00:03:24 +0000, Leo Carreon wrote:

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.)

On 2013-05-06 18:15:27 +0000, albert wrote:

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.

On 2013-05-06 20:53:05 +0000, Leo Carreon wrote:

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.

On 2013-05-06 21:33:20 +0000, Leo Carreon wrote:

Created attachment 243425
Zip file containing doxygen config file and resulting pdf file

On 2013-05-06 21:35:16 +0000, Leo Carreon wrote:

Created attachment 243426
Source files used to produce pdf file

On 2013-05-08 17:51:21 +0000, albert wrote:

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.

On 2013-05-10 11:49:03 +0000, Dimitri van Heesch wrote:

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...

On 2013-05-10 11:59:14 +0000, Dimitri van Heesch wrote:

*** Bug 699782 has been marked as a duplicate of this bug. ***

On 2013-05-10 12:04:12 +0000, Dimitri van Heesch wrote:

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.

On 2013-05-10 17:00:09 +0000, albert wrote:

When zooming in at some moments the lines do reappear but also disappear again.

On 2013-05-10 20:09:49 +0000, Leo Carreon wrote:

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.

On 2013-05-12 17:57:09 +0000, albert wrote:

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).

On 2013-05-12 17:59:10 +0000, albert wrote:

Oops I added comment with wrong bug report. This problem looks like to be solved. Boxes are shown and remain whilst zooming.

On 2013-05-19 12:36:05 +0000, Dimitri van Heesch wrote:

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.

@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