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 759275 - Stray hyphen in man-page output with BRIEF_MEMBER_DESC=no
Stray hyphen in man-page output with BRIEF_MEMBER_DESC=no
Status: RESOLVED OBSOLETE
Product: doxygen
Classification: Other
Component: general
1.8.10
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
[moved_to_github]
Depends on:
Blocks:
 
 
Reported: 2015-12-09 21:20 UTC by Jonathan Wakely
Modified: 2018-07-30 10:32 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Jonathan Wakely 2015-12-09 21:20:19 UTC
With:

HIDE_UNDOC_MEMBERS = no
BRIEF_MEMBER_DESC = no
GENERATE_MAN = yes

The man page output starts with:

NAME
       ns::foo -

from the source:

.SH NAME
ns::foo \-


When the BRIEF_MEMBER_DESC is not shown the hyphen should probably not be present.
Comment 1 Jonathan Wakely 2015-12-11 12:14:30 UTC
After trying some different options and thinking about this further, I think the NAME at the top of the man page should always include the brief descrption for the class, so should completely ignore the value of BRIEF_MEMBER_DESC.

Man pages are supposed to start with:

NAME
        foo - a brief description

and the description for the class is not a MEMBER desc anyway, because it's not a member, so should not be affected by BRIEF_MEMBER_DESC.
Comment 2 André Klapper 2018-07-30 10:32:35 UTC
As discussed in https://github.com/doxygen/doxygen/pull/734 , Doxygen has moved its issue tracking to 

   https://github.com/doxygen/doxygen/issues

All Doxygen tickets in GNOME Bugzilla have been migrated to Github. You can subscribe and participate in the new ticket in Github. You can find the corresponding Github ticket by searching for its Bugzilla ID (number) in Github.

Hence I am closing this GNOME Bugzilla ticket.
Please use the corresponding ticket in Github instead. Thanks a lot!