Package: doxygen
Version: 1.7.4-2
Severity: normal

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.

This issue causes many manpage-has-errors-from-man (can't break line)
warnings from lintian.

Attachment: smime.p7s
Description: S/MIME cryptographic signature

Reply via email to