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.

albert · Accepted Answer · 2019-03-25 15:37:56Z

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, 2019 at 15:37

albert

9,2003 gold badges24 silver badges42 bronze badges

answered Mar 13, 2014 at 16:45

Nick

1,4231 gold badge16 silver badges47 bronze badges

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

3 Comments

Hi-Angel Over a year ago

Worth noting, the CSS is used by having HTML_EXTRA_STYLESHEET = doxygen-styles.css in the doxygen configuration file.

kakyo Over a year ago

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?

Nick Over a year ago

@kakyo Doxygen supports PHP Markdown Extra and GitHub Flavored Markdown out of the box 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.

kakyo · Accepted Answer · 2021-03-23 02:37:31Z

-1

Found the solution myself:

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

For example

\:\: 

\-\>

edited Mar 23, 2021 at 2:37

answered Jul 12, 2013 at 17:25

kakyo

11.8k14 gold badges94 silver badges173 bronze badges

4 Comments

Jasper Blues Over a year ago

How do you escape the tokens? backslash?

kakyo Over a year ago

@Jasper Blues Yes, it's backslash.

kakyo Over a year ago

What's that "#"? If you were talking about "::", then you need to escape both ":" separately.

jww Over a year ago

You should provide an working example for others looking for the answer.

Collectives™ on Stack Overflow

How to generate inline code section with Doxygen?

2 Answers 2

3 Comments

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related