內聯文檔Typedef枚舉的註釋塊

Question

問題：Objective-C（iOS）中的typedef枚舉如何包含Documentation註釋塊？

上下文：我正在構建一個框架，需要確保我的解析器在第三方開發人員的內部有良好的文檔以享受更多更好的效果。 :)

代碼：

/*! 
@typedef SCElementTypes 
@brief Types of Element SCParser may find and attempt to define 
@constant kCharacters Not a Tag. 
@constant kOpenTag Tag Opens 
@constant kCloseTag Tag Closes 
@constant kSingleTag Tag Is Single 
*/ 
typedef enum SCElementTypes : NSUInteger { 
    kCharacters = (1 << 0), 
    kOpenTag = (1 << 1), 
    kCloseTag = (1 << 2), 
    kSingleTag = (1 << 3) 
} SCElementTypes; 

注：我知道如何使文檔註釋塊爲一個typedef工作（其中很多事情），但不枚舉的typedef ...

Answer 1

像這樣：

typedef enum SCElementTypes : NSUInteger 
{ 
    /**Character description*/ 
    kCharacters = (1 << 0), 

    /**OpenTag description*/ 
    kOpenTag = (1 << 1), 

    /**...*/ 
    kCloseTag = (1 << 2), 
    kSingleTag = (1 << 3) 
} SCElementTypes;