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 754184 - \bug paragraph doesn't end with a new sectioning command
\bug paragraph doesn't end with a new sectioning command
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.10
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2015-08-27 15:47 UTC by Marc
Modified: 2015-12-30 10:18 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Marc 2015-08-27 15:47:20 UTC
This bug can be seen in the example output for the command \author in doxygen's manual pages: The warning and copyright paragraphs are nested into the bug paragraph.

Here is the link to the respective online manual's page:

http://www.stack.nl/~dimitri/doxygen/manual/examples/author/html/class_some_nice_class.html

The bug seems to occur with most sectioning commands that follow directly at the next line after the \bug command.
Comment 1 albert 2015-08-27 16:59:47 UTC
Looks like the problem appeared first time in the version 1.8.6 after the @parblock command has been introduced.

Offending code in commentcnv.l (git reference: September 24 2013, 3b9f4d9cee85686861070c68a53c9db369589a6e) looks like to be:
  if (cmdPtr->endsBrief && inContext!=OutputXRef)
when removing the:
  && inContext!=OutputXRef
the output looks like the 1.8.5 output again, but I'm not sure about any side effects.

A workaround for this problem is to put an empty line before (in this case) the \warning command.
(the documentation states:
The \bug command ends when a blank line or some other sectioning command is encountered.

looks like the later does not work any more).
Comment 2 Dimitri van Heesch 2015-10-18 15:07:00 UTC
I agree that this is a bug.

The mentioned change was done to support this case, where the @parblock should become part of the @todo.

   /**
   *  Text
   *  @todo 
   *  @parblock
   *  First paragraph
   *  
   *  Second paragraph
   *  @endparblock
   *  More text.
   */

We need to look for a better solution.
Comment 3 Dimitri van Heesch 2015-10-24 17:02:19 UTC
A fix has been committed to GitHub:
https://github.com/doxygen/doxygen/commit/13e2b18c93df1351c4e91d13a7fe224b4841fa73
Comment 4 Dimitri van Heesch 2015-12-30 10:18:59 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.11. 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).