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

doxygen generates incorrect documentation for C enum in latex (Origin: bugzilla #769736) #6048

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.8.11 on platform Other
Assigned to: Dimitri van Heesch

On 2016-08-11 09:47:52 +0000, szymon.czapiga@nokia.com wrote:

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.

On 2016-08-21 14:21:24 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next GIT update.

On 2016-09-05 13:45:45 +0000, Dimitri van Heesch wrote:

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

@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