Menu
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.
263
You can put example source code in a special path defined in the doxygen config under EXAMPLE_PATH , and then insert examples with the @example tag. Doxygen will then generate an extra page containing the source of the example. It will also set a link to it from the class documentation containing the example tag.
Add \n followed by a space at the end of your line [1]. Especially recommended when editing with Emacs, which reacts in weird ways to the other suggested solution <br> . [1] As per @albert's comment. Works for me under Doxygen 1.8.
Doxygen is a well-known tool for generating documentation directly out of the annotated source code. However, it can be utilized to create technical documentation, too. In version 1.8. 0, Markdown support was introduced to Doxygen.
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>
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
