Apple 提供了 NS_ENUM 和 NS_OPTION 宏(链接至文档)来定义 Objective-C 中的枚举。以下是 NS_ENUM 的示例:--- EnumName.h ---#pragma once#import
Apple 提供了 NS_ENUM
和 NS_OPTION
宏( 链接至文档 )来定义 Objective-C 中的枚举。以下是的示例 NS_ENUM
:
--- EnumName.h ---
#pragma once
#import <Foundation/NSObjCRuntime.h>
typedef NS_ENUM(NSUInteger, EnumName)
{
EnumMemberA,
EnumMemberB,
EnumMemberC,
};
为这种枚举类型定义(以及枚举成员)编写 Doxygen 文档的语法是什么?
起初我尝试了直观的方法: @brief
在定义之前写一个文档块。
--- EnumName.h ---
#pragma once
#import <Foundation/NSObjCRuntime.h>
/// @file
/// @brief A brief description.
typedef NS_ENUM(NSUInteger, EnumName)
{
EnumMemberA,
EnumMemberB,
EnumMemberC,
};
结果:Doxygen 在其生成的输出 () 中包含了文档块,但将定义解析为函数 ()。使用枚举类型的位置(例如函数/方法参数)未链接 ()。
接下来我尝试 @enum EnumName
在前面添加一个命令。
--- EnumName.h ---
#pragma once
#import <Foundation/NSObjCRuntime.h>
/// @file
/// @enum EnumName
/// @brief A brief description.
typedef NS_ENUM(NSUInteger, EnumName)
{
EnumMemberA,
EnumMemberB,
EnumMemberC,
};
结果:Doxygen 发出此警告: warning: Documentation for undefined enum 'EnumName' found
并且在其生成的输出中根本不包含文档块()。
我可以理解 Doxygen 可能无法解析 typedef NS_ENUM
构造,但在这种情况下,我希望能够编写与实际源代码分离的文档块。
我正在使用 Doxygen 1.10.0,通过 Homebrew 安装在 Intel Mac 上的 macOS 13.5.2 上。
如何使用 Doxygen 记录:typedef NS_ENUM(NSUInteger, EnumType)
下载声明:
本站所有软件和资料均为软件作者提供或网友推荐发布而来,仅供学习和研究使用,不得用于任何商业用途。如本站不慎侵犯你的版权请联系我,我将及时处理,并撤下相关内容!