使用Doxygen链接到ivars或方法

时间:2011-10-29 10:59:01

标签: objective-c doxygen

我尝试按照Doxygen文档添加到ivars和方法的链接,但Doxygen不会解释它们。

这就是我正在做的事。

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

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

解决方案:没有为未记录的内容创建链接。刚刚向我的ivar添加了文档,并创建了链接。

1 个答案:

答案 0 :(得分:1)

尝试以下方法:

/** 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.
 */