如何用doxygen注释Obj C typedef块

时间:2015-02-19 09:09:03

标签: objective-c comments doxygen typedef

当我在这个Obj-C代码上运行doxygen时,HTML输出中既没有签名也没有注释。我是否需要添加标签(@typedef)或传递ENABLE_PREPROCESSING,MACRO_EXPANSION,EXPAND_ONLY_PREDEF,PREDEFINED和 SHOW_FILES?我已经尝试了几种没有运气的组合。

/**
 * This is the brief comment.  This is the detailed comment.
 *
 * @param error The error describing failure.
 */
typedef void(^ServiceCompletion)(NSError *error);

提前感谢您的帮助。

1 个答案:

答案 0 :(得分:0)

答案是@related标签(也称为\ related,@ relates和\ relate)。没有其他的。非常简单而优雅。此标记告诉Doxygen它标记的typedef MyService接口相关。此标记是必需的,因为typedef不是接口的成员。

迪米特里本人提供了解决方案:https://bugzilla.gnome.org/show_bug.cgi?id=720046

/**
 * @related MyService
 *
 * This is the brief comment.  This is the detailed comment.
 *
 * @param error The error describing failure.
 */
typedef void(^ServiceCompletion)(NSError *error);

@interface MyService : NSObject
...
@end