How to generate inline code section with Doxygen?

Question

My narration has code snippets, e.g., ::SomePlatformAPI() that are not part of my code base and Doxygen warns that

warning: explicit link request to 'SomePlatformAPI()' could not be resolved

I tried to add \code and \endcode around it but then the code block starts a new paragraph and breaks the current narration.

Is there a way to add inline code blocks?

UPDATE:

This turns out to be only a problem of Doxygen 1.8 and above. With 1.6, you don't have this issue.

score 21 · Answer 1 · edited Mar 25 '19 at 15:37

21

Doxygen markdown support allows you to insert inline code blocks using the ` backtick character. http://www.doxygen.nl/manual/markdown.html#md_codespan

When you do this the code will be injected inline, but it will be monospaced, and doxygen processing will be disabled between the two ` marks. So you will not have to escape tokens.

A a matter of fact, to make it stand out even more I included an extra style sheet with the following in it:

code
{
    background-color:#EFD25E;
}

That will hylight the inline code. Doxygen's code spans use a custom tag

<code></code>

edited Mar 25 '19 at 15:37

albert

8,285
3
19
32

answered Mar 13 '14 at 16:45

Nick

1,361
1
14
42

2

Worth noting, the CSS is used by having `HTML_EXTRA_STYLESHEET = doxygen-styles.css` in the doxygen configuration file. – Hi-Angel Jun 23 '20 at 08:31
1

Do you mean that markdown comes with the generic doxygen engine? Is it that I can just mix in markdown syntax in the main text? – kakyo Aug 11 '22 at 04:03
1

@kakyo [Doxygen supports PHP Markdown Extra and GitHub Flavored Markdown out of the box](https://doxygen.nl/manual/markdown.html) within Doxygen comment blocks. Doxygen can also process complete Markdown documents provided the file extension is .md or .markdown. Markdown documents will be turned into pages that show up under the "related pages" menu. However, there is an option to use a markdown document as the mainpage, e.g. README.md could be your mainpage in bitbuckt/github and also your doxygen output. – Nick Aug 12 '22 at 13:03

kakyo · Accepted Answer · 2021-03-23T02:37:31.347

-2

Found the solution myself:

All I need to do is to escape the :: token and other similar tokens ->.

For example

\:\: 

\-\>

edited Mar 23 '21 at 02:37

answered Jul 12 '13 at 17:25

kakyo

10,460
14
76
140

How do you escape the tokens? backslash? – Jasper Blues Dec 08 '13 at 02:23
2

@Jasper Blues Yes, it's backslash. – kakyo Mar 14 '14 at 17:37
What's that "#"? If you were talking about "::", then you need to escape both ":" separately. – kakyo May 03 '14 at 17:16
7

You should provide an working example for others looking for the answer. – jww Nov 02 '15 at 00:54

How to generate inline code section with Doxygen?

2 Answers2