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 747780 - man output should escape minus signs
man output should escape minus signs
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.8
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2015-04-13 14:56 UTC by Ferenc Wágner
Modified: 2015-06-27 19:01 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Ferenc Wágner 2015-04-13 14:56:00 UTC
If I generate a man page for this (pure comment) common.h:

/**
 * \file common.h
 * \brief return -1
 */

the generated common.h.3 contains

[...]
common.h \- 
return -1
[...]

The problem is that groff interprets plain '-' characters as hyphens, not minus signs, breaking search and copy&paste in the resulting man pages in UTF-8 locales (where these are represented as different characters). As Doxygen does not distinguish hyphens and minus signs, it should play safe by emitting only the latter, ie. inserting backslashes like it does with the separator above.

Please see also http://doxygen.10944.n7.nabble.com/hyphen-used-as-minus-sign-td3908.html and the links therein.
Comment 1 albert 2015-04-13 16:50:14 UTC
I've just pushed a proposed patch to github (pull request 330)
Comment 2 Dimitri van Heesch 2015-04-14 17:32:05 UTC
Thanks, I've merged the pull request
Comment 3 Dimitri van Heesch 2015-06-27 19:01:36 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.10. 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 (preferably in the form of a self-contained example).