Link to ivars or methods with Doxygen

Question

I tried following the Doxygen documentation to add links to ivars and methods but none of them are interpreted by Doxygen.

This is what I'm doing.

@interface MyClass: NSObject
{
  int x;
}
@end

Somewhere else:
/**
Trying to link to x.
MyClass::x
*/

SOLUTION: No link is created to something that is not documented. Just added documentation to my ivar and the link was created.

Sorry, the post has been corrected. It was a mistake writing the code. I cannot live without autocorrection! — David Casillas

doxygen doxygen · Accepted Answer · 2011-10-31T22:21:46

Try the following:

/** Class documentation. */
@interface MyClass: NSObject
{
    /** This documentation is for x. */
    int x;
}
@end


/** @page mypage A page
    This is a \ref MyClass::x "link" to x.
    This also links to x: MyClass::x.
 */

Link to ivars or methods with Doxygen

1 Answers