2010-01-11 3 views
11

Doxygen claim better handling of Objective-C categories의 최신 릴리스에도 불구하고 여전히 내 소스 코드에서 범주를 막는 것으로 보입니다. 나는 누군가가 카테고리를 적절하게 문서화했다면 궁금해. 가 Doxygen 및 Objective-C 범주

Doxygen을 수퍼 클래스로 파일을 참조한다 NSString_CCFExtension.m

NSString_CCFExtensions.h라는 인터페이스 파일 및 실행 파일을

@interface NSString (CCFExtensions) 

:

예로서, I로 정의는 NSString의 카테고리를 가지고 ; 겉으로보기에는 유효한 doxygen 구문에도 불구하고 카테고리 메소드가 문서화되어 있지 않습니다.

Objective-C 카테고리를 얻기위한 올바른 소스 마크 업은 무엇입니까?

답변

14

일부 회귀 테스트 (그리고 약간의 상식) 솔루션 후 :

을 :

하는의 내가 doxygen이 내 카테고리 헤더 파일을 구문 분석하는 것은이 같은 약 보일 것입니다, NSObject의에 카테고리 CAT1 있다고 가정 해 봅시다

#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 

, 클래스 이름과 카테고리 이름 사이에 공백을 두지.