View Issue Details

IDProjectCategoryView StatusLast Update
0032786Open CASCADEOCCT:Documentationpublic2022-10-24 10:39
Reporterkgv Assigned Toabv  
PrioritynormalSeverityminor 
Status newResolutionopen 
Product Version7.6.0 
Target Version7.8.0 
Summary0032786: Documentation - Doxygen 1.9 shows raw HTML tags within section headers
DescriptionDoxygen 1.9 generates headers like this:
 Use < em >sizeof()< /em > to calculate sizes [MANDATORY]
...
 Use < em >OSD::SetSignal()< /em > to catch exceptions

from dox/contribution/coding_rules.md:
### Use *sizeof()* to calculate sizes [MANDATORY]
...
### Use *OSD::SetSignal()* to catch exceptions

It seems that this is a bug in Doxygen:
https://github.com/doxygen/doxygen/pull/7388

Older versions have the same issue with headers, but it didn't appear for this article.
Newer versions have an option `TOC_INCLUDE_HEADINGS` set to 5 by default, so that these headers are now added to table of content.
Disabling this feature allows to fix unexpected generation output:
TOC_INCLUDE_HEADINGS=0


The following options might be considered:
- Wait for a bugfix in Doxygen itself;
- Disable TOC generation from MarkDown headers (TOC_INCLUDE_HEADINGS=0);
- Remove extra formatting from headers.
TagsNo tags attached.
Test case number

Activities

There are no notes attached to this issue.

Issue History

Date Modified Username Field Change
2022-01-19 12:46 kgv New Issue
2022-01-19 12:46 kgv Assigned To => abv
2022-01-19 12:46 kgv Description Updated
2022-01-19 12:48 kgv Description Updated
2022-10-24 10:39 szy Target Version 7.7.0 => 7.8.0