@showcontent tag

This tag indicates that the content or body of a symbol must be displayed in the detailed documentation:

  • Macro body will be exposed in a code snippet box

  • Variable initialization value will appear in a code snippet box

The @showvalue tag can be used instead to avoid code snippet boxes for short content.

This can be enforced globally using the show_macro_content configuration option.

See also @hidecontent tag section and @showvalue tag section.

Example  

The following declarations:

/**
@showcontent
This is the macro description.
*/

#define SC_FOO do { ... } while (0);

/**
@showcontent
This is the variable description.
*/

static const char* sc_str[] = {
"foo", "bar"
};

generate the following detailed member documentation sections:

#define SC_FOO  

This macro is declared in doc/examples.h source file, line 45.

This is the macro description.

This macro expands to:

do { ... } while (0);

const char *sc_str[]  

This variable is declared in doc/examples.h source file, line 56.

This is the variable description.

Initialization value of this variable is:

{"foo","bar"}

Valid XHTML 1.0 StrictGenerated by diaxen on Sun Jan 8 22:43:00 2012 using MkDoc