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 325266 - man generator: missing linebreak before .SH
man generator: missing linebreak before .SH
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.4.x
Other All
: Normal minor
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2005-12-29 23:15 UTC by Tom Aeby
Modified: 2013-05-19 12:35 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
PATCH: close header properly (627 bytes, patch)
2013-02-16 19:02 UTC, albert
none Details | Review

Description Tom Aeby 2005-12-29 23:15:13 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?
Comment 1 albert 2013-02-16 19:02:16 UTC
Created attachment 236398 [details] [review]
PATCH: close header properly

Printed newline in endHeader in case position is not ot the beginning of the line.
Comment 2 Dimitri van Heesch 2013-03-31 11:52:51 UTC
Thanks, I'll include the patch in the next subversion update.
Comment 3 Dimitri van Heesch 2013-05-19 12:35:44 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.