Doxygen和Objective-C分类

11
尽管最新的Doxygen版本声称更好地处理Objective-C分类,但它似乎仍无法处理我的源代码中的分类。我想知道是否有人成功地将其文档化了。
例如,我定义了一个NSString类别:
@interface NSString (CCFExtensions)

使用一个名为NSString_CCFExtensions.h的接口文件和NSString_CCFExtension.m的实现文件。
Doxygen将引用带有超类的文件;但是,尽管看起来有效的doxygen语法,但没有一个类别方法被记录。
获取Objective-C类别工作的正确源标记是什么?
1个回答

14

经过一些回归测试(以及一点常识)后,解决方案如下:

假设我有一个名为Cat1的分类别在NSObject上,为了让doxygen解析我的分类头文件,它应该大致如下:

#import <Cocoa/Cocoa.h>

/*! \category NSObject(Cat1) 
    \abstract A category on NSObject
*/

@interface NSObject(Cat1)
    - (void)foo;
@end

以及实现文件:

#import "NSObject_Cat1.h"

@implementation NSObject(Cat1)

- (void)foo {
    //  do something
}

@end

重要的是,在类名和类别名之间不要放置空格。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接