Skip to content
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 output should escape minus signs (Origin: bugzilla #747780) #5777

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

Comments

Projects
None yet
1 participant
@doxygen
Copy link
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component general for ---
Reported in version 1.8.8 on platform Other
Assigned to: Dimitri van Heesch

On 2015-04-13 14:56:00 +0000, Ferenc Wágner wrote:

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.

On 2015-04-13 16:50:14 +0000, albert wrote:

I've just pushed a proposed patch to github (pull request 330)

On 2015-04-14 17:32:05 +0000, Dimitri van Heesch wrote:

Thanks, I've merged the pull request

On 2015-06-27 19:01:36 +0000, Dimitri van Heesch wrote:

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).

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.