如何让Doxygen在枚举详细说明中显示定义的枚举值?
解决Doxygen枚举详细页不显示定义值的问题
检查并调整Doxygen配置项
打开你的Doxyfile配置文件,确认以下几个关键设置:
ENUM_VALUES_PER_LINE:设置为1(或其他非0值),让每个枚举值单独占一行显示,避免因自动换行导致值被隐藏。默认值可能是0,会自动合并多行,调整后能确保详细页清晰展示每个枚举值。SHOW_ENUM_VALUES:确保该选项设为YES,这个配置控制Doxygen是否在枚举的详细描述中展示具体的枚举值和注释。EXTRACT_ALL:如果部分枚举值没有被代码其他地方引用,把这个选项设为YES,强制Doxygen提取所有枚举成员,不管引用情况。
优化代码注释(可选)
把枚举的多行注释改成Doxygen标准的块注释格式,帮助解析器更好识别:
/** * Board version values. Board version is * provided by three signals in the PCB, * which are treated like a 3-bit value. */ typedef enum _boardVer { /// First prototype version board_REV_A = 0x07, /// Second prototype version board_REV_B = 0x03, /// Current pre-production version. It will /// be production if no issues are found board_REV_C = 0x05 } boardVer;
重新生成文档
删掉之前生成的旧文档,重新运行Doxygen,枚举的详细页面就能正常显示每个定义的枚举值和对应的注释了。
内容的提问来源于stack exchange,提问作者Barleyman
相关产品推荐
相关产品推荐

