RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 1483569 - Incorrect processing of code blocks in doxygen
Summary: Incorrect processing of code blocks in doxygen
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: doxygen
Version: 7.3
Hardware: All
OS: Linux
unspecified
medium
Target Milestone: rc
: ---
Assignee: Than Ngo
QA Contact: Evgeny Fedin
URL:
Whiteboard:
Depends On:
Blocks: 1716965
TreeView+ depends on / blocked
 
Reported: 2017-08-21 12:24 UTC by Danny Smit
Modified: 2020-03-31 19:42 UTC (History)
2 users (show)

Fixed In Version: 1.8.5-4
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-03-31 19:42:31 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHSA-2020:1034 0 None None None 2020-03-31 19:42:37 UTC

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


Note You need to log in before you can comment on or make changes to this bug.