GNOME Bugzilla – Bug 325266
man generator: missing linebreak before .SH
Last modified: 2013-05-19 12:35:44 UTC
Please describe the problem: When facing something like @defgroup mantest Test Manpage @section syn SYNOPSIS some text the generated man page contains ... .SH NAME Test Manpage \- .SH SYNOPSIS ... with a missing line break before .SH Steps to reproduce: 1. Put the above sample into a .dox file 2. run it through doxygen with MAN_OUTPUT=yes 3. display the resulting man page Actual results: The title "SYNOPSIS" is displaying within the NAME section instead of as a section title Expected results: "SYNOPSIS" should display as a section header Does this happen every time? Yes Other information: It seems that in the above case mangen.cpp method call order is: - ... - endTitleHead() - printDoc() ... endTitleHead prints the head up to .SH NAME name of the man page \- without printing a line break and sets firstCol to false. Then, printDoc() is called and does not respect firstCol. I have just added a if (!firstCol) t << endl; which seems to fix this. I am not sure if this should happen at all since obviously endTitleHead() expects that something else is being printed just after the head that is not going to be printed - or what else would the "\-" be for?
Created attachment 236398 [details] [review] PATCH: close header properly Printed newline in endHeader in case position is not ot the beginning of the line.
Thanks, I'll include the patch in the next subversion update.
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.