Bug 1483569

Summary:	Incorrect processing of code blocks in doxygen
Product:	Red Hat Enterprise Linux 7	Reporter:	Danny Smit <danny.smit.0>
Component:	doxygen	Assignee:	Than Ngo <than>
Status:	CLOSED ERRATA	QA Contact:	Evgeny Fedin <efedin>
Severity:	medium	Docs Contact:
Priority:	unspecified
Version:	7.3	CC:	djez, efedin
Target Milestone:	rc
Target Release:	---
Hardware:	All
OS:	Linux
Whiteboard:
Fixed In Version:	1.8.5-4	Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2020-03-31 19:42:31 UTC	Type:	---
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:
Bug Blocks:	1716965

Description Danny Smit 2017-08-21 12:24:16 UTC

User-Agent:       Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.91 Safari/537.36 Vivaldi/1.92.917.39
Build Identifier: 

As stated here: https://bugzilla.gnome.org/show_bug.cgi?id=707567
there is a regression bug in doxygen 1.8.5 concerning the processing of code blocks in documentation.

It should be fixed already in newer versions of doxygen.


Issue details:
--------------
For a code snippet like:

/**
 * Functor to delete objects pointed by a container of pointers.
 *
 * A typical usage might be like:
 * @code
 * list<Object*> l;
 * ...
 * for_each(l.begin(), l.end(), delete_object());
 * @endcode
 */
struct delete_object
{
    template <typename _Tp>
    void operator()(_Tp* pointer) const
    {
        delete pointer;
    }
};

Previously (at least up to 1.8.0) Doxygen was able to generate the correct HTML/LaTeX output like:

 list<Object*> l;
 ...
 for_each(l.begin(), l.end(), delete_object());

1.8.5 generates:

* list<Object*> l;
* ...
* for_each(l.begin(), l.end(), delete_object());
*

Reproducible: Always

Steps to Reproduce:
Generate doxygen documentation with a code block as shown in the details above.

Actual Results:  
The output includes asterisks as shown in the details above.



An updated version of doxygen should have a fix for this already.

Comment 2 Than Ngo 2017-08-21 16:43:52 UTC

I can reproduce this issue with your testcase. Thanks for your report.

Comment 8 Than Ngo 2019-07-29 15:13:22 UTC

it's fixed in 1.8.5-4

Comment 12 errata-xmlrpc 2020-03-31 19:42:31 UTC

Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2020:1034