Doxygen doesn't correctly generate code spans or code blocks

Question

I have the following markdown snippet in a markdown file in my documentation:

```cpp
/**
 * Input Description:
 *
 * @depth_test: true
 * @topology: line list
 * @line_width: <float value>
*/
```

The `Input Description:` header is necesary and it is case sensitive. Also, there can only be one such comment per shader group and it must be put on the vertex shader of that group.

The valid values for `@topology:` are:

This is how it's formatted in a regular markdown explorer:

This is how it comes out in Doxygen:

The documentation: https://www.doxygen.nl/manual/markdown.html#md_codeblock Says code can be formatted by indenting it by at least 4 spaces (and indeed this does "work" except there's no language specific syntax highlighting.)

I guess I can live with that, but it also explicitly says code spans are supported and the code spans are not being formatted properly.

Is it possible to get syntax highlighitng for code blocks in doxygen? How do I fix the code spans?

Which version of doxygen are you using?

albert
– albert

2020-06-21 22:12:54 +00:00
Commented Jun 21, 2020 at 22:12 — albert
– albert, Commented Jun 21, 2020 at 22:12
My version is 1.8.19

Makogan
– Makogan

2020-06-22 02:56:36 +00:00
Commented Jun 22, 2020 at 2:56 — Makogan
– Makogan, Commented Jun 22, 2020 at 2:56

albert · Accepted Answer · 2020-06-22 08:19:30Z

1

In case of a code block with triple backticks (```) doxygen sees the part as a code block analogous to a file generated with SOURCE_BROWSER = YES / a code snippet (\snippet) or an inline code block and thus honors the setting of STRIP_CODE_COMMENTS. When setting STRIP_CODE_COMMENTS to YES the doxygen relevant comment blocks (like /**) are not shown in the output only the normal comment blocks (like /*). Setting STRIP_CODE_COMMENTS = NO will solve the problem.

From the documentation (https://www.doxygen.nl/manual/config.html#cfg_strip_code_comments):

STRIP_CODE_COMMENTS

Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any special comment blocks from generated source code fragments. Normal C, C++ and Fortran comments will always remain visible.

The output with STRIP_CODE_COMMENTS = NO:

answered Jun 22, 2020 at 8:19

albert

9,2003 gold badges24 silver badges42 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Doxygen doesn't correctly generate code spans or code blocks

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related