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 769736 - doxygen generates incorrect documentation for C enum in latex
doxygen generates incorrect documentation for C enum in latex
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.11
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2016-08-11 09:47 UTC by szymon.czapiga
Modified: 2016-09-05 13:45 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description szymon.czapiga 2016-08-11 09:47:52 UTC
Problem is that doxygen adds \\* after enum values documentation in latex output. When ENUM_VALUES_PER_LINE is set to 1 this symbol(\\*) prohibits a page break and enum values documentation goes beyond page, page bottom margin and most of it gets lost.

My code looks like:

/*!
 *  @brief  Brief enum description
 */
enum EnumName
{
    EnumName_EnumVal1 = SOME_MACRO(1),  /**< EnumName_EnumVal1 description */
    EnumName_EnumVal2 = SOME_MACRO(2),  /**< EnumName_EnumVal2 description */
    EnumName_EnumVal3 = SOME_MACRO(3),  /**< EnumName_EnumVal3 description */
(more values - enough to fully cover 2-3 A4 pages)
    EnumName_Last  /**< EnumName_EnumVal description */
}

I think problem is with if-else in function:
latexgen.cpp:2127: void LatexGenerator::lineBreak(const char *)

since \\* is generated by its else branch.
Comment 1 Dimitri van Heesch 2016-08-21 14:21:24 UTC
Confirmed. Should be fixed in the next GIT update.
Comment 2 Dimitri van Heesch 2016-09-05 13:45:45 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.12. 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).