5

Doxygen を使用して、Objective-C で記述された API を文書化しています。
Doyxygen は NS_ENUM typedef を理解できません。

この解決策を見つけましたが、うまくいきませんでした。

ENABLE_PREPROCESSING   = YES 
MACRO_EXPANSION        = YES 
EXPAND_ONLY_PREDEF     = YES 
PREDEFINED             = NS_ENUM(x,y)=y 

Regards, 
  Dimitri 

これは私の入力ファイルです:

/**
 *  Represent the possible states.
 */
typedef NS_ENUM(NSInteger, ABEnumType)
{
    /**
     *  State A.
     */
    StateA = 0,
    /**
     *  State B.
     */
    StateB
};

これは私が得る出力です:

Preprocessing /src/ABEnumType.h...
error: /src/ABEnumType.h:17:17: error: C++ requires a type specifier for all declarations [clang]
error: /src/ABEnumType.h:17:28: error: unknown type name 'ABEnumType' [clang]
error: /src/ABEnumType.h:18:1: error: function definition is not allowed here [clang]
error: /src/ABEnumType.h:17:9: error: C++ requires a type specifier for all declarations [clang]
Parsing file /src/ABEnumType.h...
4

3 に答える 3

5

次の設定が機能しました。

 ENABLE_PREPROCESSING   = YES 
 MACRO_EXPANSION        = YES 
 EXPAND_ONLY_PREDEF     = YES 
 PREDEFINED             = NS_ENUM(x,y)=enum y 

これにより、doxygen で生成されたドキュメントにすべての NS_ENUM 構造が表示されます。

于 2014-08-26T07:35:34.377 に答える
2

Doxygen が失敗した場合は、いつでもHeaderDocsを試すことができます。

編集: テスト クラスで headerdocs を試しましたが、NS_ENUM を適切にサポートしていると思います。

//
//  VLTTestClass.h
//  VPNLoginTest
//

#import <Foundation/Foundation.h>

/*!
 Test class type description.
 */
typedef NS_ENUM(NSInteger, VLTestClassType) {
    /*!
     Description for type 1.
     */
    VLTestClassType1,
    /*!
     Description for type 2.
     */
    VLTestClassType2
};

/*!
 Description for test class
 */
@interface VLTTestClass : NSObject

@end

headerdoc2html は次のとおりです: http://pastebin.com/q6RsR0tU

于 2014-04-16T07:53:03.440 に答える