GNOME Bugzilla – Bug 699731
Class documentation beyond footer
Last modified: 2018-07-30 10:58:43 UTC
I am building my documentation on Fedora 18 which generates a PDF file. I have noticed that one of the classes in the resulting PDF file have gone beyond the footer. (Please see page 65 in the attached PDF file.)
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.
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.
Created attachment 243435 [details] Doxygen config file
Sorry, I was unable to reproduce the same problem with a smaller set of files. I'm also unable to attach the original PDF file because of its size.
What is the size of the (compressed) files Is it possible to make the files available on a ftp server?
The size of the zipped up PDF file is 1.81 MB. I can make the file available on an ftp server if you have one. Sorry, I don't have a publicly available ftp server. BTW, I have recently made some minor changes to the documentation in the source and the problem has moved to different pages in the resulting PDF file. Another observation is that the problem always happens on a parameter box. It happened on 7 pages of the most recent PDF file. The problem may still happen on a smaller set of my source files but I have to experiment which combination of source files I can make it happen on.
OK, I was finally able to reproduce the problem with a smaller set of my source files and I am attaching them now.
Created attachment 243636 [details] ZIP file containing doxygen config file and resulting PDF file
Created attachment 243637 [details] Archive containing source files used
The example shows the problem on (a.o.) page 28 (routine mvSetDate), page 47 (routine smvPutNumber), page 73 (routine smvPutTzName). Problem still occurs in SVN version 846 (1.8.3.1-20130402)
Looks like the \vspace{-40pt}'s in doxygen.sty were causing this. Reducing this to \vspace{-25pt} keeps the tables above the margin.
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).
Yes, I see that my change doesn't really work and causes the extra spacing, so I'll revert it. So far I haven't found a generic way to prevent LaTeX from occasionally overflowing the footer :-(
I have better luck using the supertabular package instead of the longtable package, so I'll use that instead.
Created attachment 244105 [details] Replacement stylesheet using supertabular package Please try this replace style file and let me know if it solves the problem.
I've tested the new doxygen.sty. - I've not seen that a table is going into the footer - a number of small tables are split over pages (e.g. page 36/37, 55/56, 70/71, 71/72, 96/97, 99/100, 138/139, 142/143, 154/155) - the word parameters is separated from the actual table (e.g. page 38/39) - the words "Parameters", "Template parameters", "Return values" and "Exceptions" are now boxed as well. I'm personally not in favor of it. - the text inside the boxes is quite close to the top of the box, nearly hitting the line on top. The spacing above the text is smaller that the spacing below the text - on page 51, 73, 85, 87, 134, 151 there is quite a bit of white space on the top of the page before the paragraph starts - quite a bit of white space on page 57, 69, 101, 129, 140
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.
Tested with 1.8.4, some problems are still present (just listing an occurrence once): - page 13/14: header "Template Parameters" separated from the table (box is gone from header) - page 17/18 lot of white space, table fits on page 17 - page 107/108 table split over pages
As discussed in https://github.com/doxygen/doxygen/pull/734 , Doxygen has moved its issue tracking to https://github.com/doxygen/doxygen/issues All Doxygen tickets in GNOME Bugzilla have been migrated to Github. You can subscribe and participate in the new ticket in Github. You can find the corresponding Github ticket by searching for its Bugzilla ID (number) in Github. Hence I am closing this GNOME Bugzilla ticket. Please use the corresponding ticket in Github instead. Thanks a lot!