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

\bug paragraph doesn't end with a new sectioning command (Origin: bugzilla #754184) #5848

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

On 2015-08-27 15:47:20 +0000, Marc wrote:

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.

On 2015-08-27 16:59:47 +0000, albert wrote:

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, SHA: 3b9f4d9) 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).

On 2015-10-18 15:07:00 +0000, Dimitri van Heesch wrote:

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.

On 2015-10-24 17:02:19 +0000, Dimitri van Heesch wrote:

A fix has been committed to GitHub:
SHA: 13e2b18

On 2015-12-30 10:18:59 +0000, Dimitri van Heesch wrote:

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

@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