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 652276 - Typedefs in manpages has too few linebreak possiblilities
Typedefs in manpages has too few linebreak possiblilities
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.7.4
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2011-06-10 11:24 UTC by Mattias Ellert
Modified: 2014-12-25 16:03 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Mattias Ellert 2011-06-10 11:24:37 UTC
The following markup:

/**
 * @defgroup mytypes My types
 * @{
 */

/**
 * This typedef will become a very long line in the man page that can not be
 * broken properly.
 */
typedef void(*myTypes_Function_Type_With_A_Long_Name)
(myTypes_Other_Type_With_A_Long_Name *first, void *second);
/**
 * @}
 */

Generates a manpage that contains the line:

.SS "typedef void(* \fBmyTypes_Function_Type_With_A_Long_Name\fP)(myTypes_Other_Type_With_A_Long_Name *first, void *second)"This typedef will become a very long line in the man page that can not be broken properly. 

When displayed using man this will not fit on a standard 80 column screen

It is not a very common problem, but it happens often enough that it is annoying.

A better display would be achieved if there was a space between the )( in the man page output:

.SS "typedef void(* \fBmyTypes_Function_Type_With_A_Long_Name\fP) (myTypes_Other_Type_With_A_Long_Name *first, void *second)"This typedef will become a very long line in the man page that can not be broken properly. 

I think this would be easier to read also for the types that do fit on one line.
Comment 1 bastien roucaries 2013-05-27 18:30:37 UTC
Any news of this bug ?
Comment 2 Mattias Ellert 2014-08-31 17:33:54 UTC
https://github.com/doxygen/doxygen/pull/214
Comment 3 Dimitri van Heesch 2014-09-04 17:56:53 UTC
Thanks, I've merged the pull request.
Comment 4 Dimitri van Heesch 2014-12-25 16:03:09 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.9. 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 (preferrably in the form of a self-contained example).