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

man generator: missing linebreak before .SH (Origin: bugzilla #325266) #1976

Closed
doxygen opened this Issue Jul 1, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 1, 2018

status RESOLVED severity minor in component general for ---
Reported in version 1.4.x on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2005-12-29 23:15:13 +0000, Tom Aeby wrote:

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?

On 2013-02-16 19:02:16 +0000, albert wrote:

Created attachment 236398
PATCH: close header properly

Printed newline in endHeader in case position is not ot the beginning of the line.

On 2013-03-31 11:52:51 +0000, Dimitri van Heesch wrote:

Thanks, I'll include the patch in the next subversion update.

On 2013-05-19 12:35:44 +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 1, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment