@alias tag

This tag declares an alternate name which can be used to refer to the declared symbol with the @ref tag. This is useful for C++ overloaded functions and other cases where the symbol name is ambiguous.

The alias name must be surrounded by double underscore characters (like __name__ ) when used with @ref tag.


@alias <name>


@alias foo1
The @ref __cmpeq__ function can be used instead.

void foo(int a);

/** The @ref __foo1__ function is more generic. */
void foo();

/** @alias cmpeq */
void operator==(int a);

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