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

Typedefs in manpages has too few linebreak possiblilities (Origin: bugzilla #652276) #4293

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

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

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

On 2011-06-10 11:24:37 +0000, Mattias Ellert wrote:

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.

On 2013-05-27 18:30:37 +0000, bastien roucaries wrote:

Any news of this bug ?

On 2014-08-31 17:33:54 +0000, Mattias Ellert wrote:

#214

On 2014-09-04 17:56:53 +0000, Dimitri van Heesch wrote:

Thanks, I've merged the pull request.

On 2014-12-25 16:03:09 +0000, Dimitri van Heesch wrote:

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

@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