@this tag

This tag is a shortcut used to start a sentence describing the symbol by writing the qualified symbol type. @This and @this are available which produce capitalized and lower case text respectively.

Syntax  

@this <end of sentence>.

Example  

These declarations:

class Object
{
public:
/** @This reads object content. */
template <typename T>
void read();

/** @This writes object content. */
virtual void write();

generate the following member details:

template <typename T> void read()  

This template function is declared in doc/examples.h source file, line 150.

This template function reads object content.

virtual void write()  

This virtual function is declared in doc/examples.h source file, line 153.

This virtual function writes object content.

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