How to preserve a comment in an example in doxygen?

@ryan.murray 

To preserve a comment in an example in Doxygen, you can use the verbatim command to ensure that the comment is displayed exactly as it is written without any processing or formatting changes.

Here's an example of how you can preserve a comment in an example using the verbatim command in a Doxygen documentation block:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

/**
 * rief This is an example function with a preserved comment.
 *
 * code
 * int add(int a, int b)
 * {
 *     return a + b;
 * }
 * endcode
 */
int add(int a, int b)
{
    return a + b;
}

By using the code and endcode commands around the comment, Doxygen will treat the text within these commands as verbatim, preserving the formatting and content exactly as it is written. This can be useful for including code examples, comments, or other types of text that you want to display exactly as it appears in the source code.