@ref tag

This tag can be used to insert a reference to a symbol.

The default link text is the fully or partially qualified non-ambiguous identifier name depending on configuration and code scope of documented symbol. An alternative link text can be provided.

See also @scope tag section.

Syntax  

@ref <identifier> [{<link text>}]
@ref {<identifier>} [{<link text>}]

See also Symbol identifiers section.

Example  

/**
@module {Foo bar}
This is an integer with same name as @ref #foo macro,
part of the @ref {+Foo bar} module.
*/

int foo;

/** This is a macro with same name as @ref foo variable,
declared in @ref {@foo.h} header. */

#define foo

Usage of the @ref tag with C++ scopes:

/** This is the global @ref foo function, which is different
from the @ref C::foo function found in class @ref C. */

void foo();

/** This class contains the @ref foo function. */
class C
{
/** This function does not use the global @ref ::foo function. */
void foo();
};

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