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 666909 - Incorrect HTML output for \copybrief
Incorrect HTML output for \copybrief
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.7.6
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2011-12-27 14:16 UTC by Etienne Dechamps
Modified: 2013-02-04 17:50 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Simple example to show problem caused by <P>'s inserted by \copybrief (1.49 KB, text/plain)
2013-02-04 17:46 UTC, Tim James 		Details

Description Etienne Dechamps 2011-12-27 14:16:47 UTC 
How to reproduce:

    $ cat >bug.h <<EOF
    //! \file bug.h
    
    //! \brief Example.
    void foo();
    
    //! \copybrief foo()
    void bar();
    EOF
    $ doxygen -g && doxygen

Expected HTML output for the function list of bug.h:

    <tr>
      <td class="memItemLeft" …>…</td>
      <td class="memItemRight" …>…</td>
    </tr>
    <tr>
      <td class="mdescLeft">&nbsp;</td>
      <td class="mdescRight">
        Example.<br>
      </td>
    </tr>
    <tr>
      <td class="memItemLeft" …>…</td>
      <td class="memItemRight" …>…</td>
    </tr>
    <tr>
      <td class="mdescLeft">&nbsp;</td>
      <td class="mdescRight">
        Example.<br>
      </td>
    </tr>

Actual output:

    <tr>
      <td class="memItemLeft" …>…</td>
      <td class="memItemRight" …>…</td>
    </tr>
    <tr>
      <td class="mdescLeft">&nbsp;</td>
      <td class="mdescRight">
        Example.<br>
      </td>
    </tr>
    <tr>
      <td class="memItemLeft" …>…</td>
      <td class="memItemRight" …>…</td>
    </tr>
    <tr>
      <td class="mdescLeft">&nbsp;</td>
      <td class="mdescRight">
        <p>
          Example.
        </p><br>
      </td>
    </tr>

Notice the additional <p> element in the brief documentation of bar(). This results in undesirable, inconsistent vertical white space in the visual result.
Comment 1 Dimitri van Heesch 2011-12-28 10:10:55 UTC 
Confirmed. Should be fixed in the next subversion update.
Comment 2 Dimitri van Heesch 2012-02-25 15:37:34 UTC 
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.0. 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.
Comment 3 Tim James 2013-02-04 17:46:34 UTC 
Created attachment 235158 [details]
Simple example to show problem caused by <P>'s inserted by \copybrief

\copybrief seems to be broken again.  In the attached example, \copybrief is used to add a short description to objects listed in an unordered list.  HTML output is as expected under 1.8.1.2 but is broken under 1.8.3.1.  Looking at the generated HTML, the problem appears to be similar as described above, with unwanted <P>s encapsulating the brief description.