@showvalue tag

This tag indicates that the value of a symbol must appear in the member details declaration title:

  • Macros content will appear next to its name. This is useful for values and short expressions macros.

  • Variable initialization value will appear next to variable name with an equal sign.

  • Enumeration values will appear in a dedicated column in the enum details table.

  • Template parameters default values will appear in class synopsis.

  • Function parameters default values will appear even in compound list of members.

  • Typedefs in members list will not appear in shortened form when short_typedefs or short_typedefs_func is enabled.

See also @showcontent tag.

Examples  

The following declarations:

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

#define SV_FOO 0x12345678

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

static const int sv_val[] = 0x12345678;

/**
@showvalue
This is the enum description.
*/

enum sv_enum {
A, //< The A value
B, //< The B value
C, //< The C value
};

generate the following detailed member documentation sections:

#define SV_FOO 0x12345678  

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

This is the macro description.

const int sv_val[] = 0x12345678  

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

This is the variable description.

enum sv_enum  

This enum is declared in doc/examples.h source file, line 78.

This is the enum description.

IdentifierValueDescription
A0The A value
B1The B value
C2The C value

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