Typedef 枚举的内联文档注释块

Question

问题：Objective-C（iOS）中的typedef枚举如何包含文档注释块？

上下文：我正在构建一个 .框架，需要确保我的解析器在内部有很好的文档记录，以便第三方开发人员享受更多更好的服务。 :)

法典：

/*!
 @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;