c - 如何使用 Doxygen 记录依赖于预处理器定义的 typedef?
问题描述
是否可以记录一个依赖于预处理器定义具有不同类型的 typedef,以使用 Doxygen 在 html 输出中显示两种选择?
我要记录的代码:
/**
* \file
*/
#ifdef _WIN32
/**
* Documentation for Windows goes here...
*/
typedef wchar_t MyChar;
#else
/**
* Documentation for Non-Windows goes here...
*/
typedef char MyChar;
#endif
我已经测试了几个与预处理器相关的设置,但我只能更改 html 输出中显示的 typedef 或合并文档。我什至设法让一个 typedef 出现在文件的概述部分,另一个出现在详细描述中。但是,我无法同时显示这两种选择。
我设法产生了以下两种选择:
----------------------------------------------
typedef wchar_t | MyChar | ....
----------------------------------------------
----------------------------------------------
typedef char | MyChar | ....
----------------------------------------------
但不是这样的
----------------------------------------------
typedef wchar_t | MyChar | ....
----------------------------------------------
typedef char | MyChar | ....
----------------------------------------------
注意:我不介意修改源代码只要
- 在文档中,这两种替代方案都合理地记录在 Doxygen 输出中;两者都
wchar_t
需要char
在typedef ...
零件中显示 - 编译器对文件的修改版本和当前版本产生相同的结果
- IDE 自动补全,尤其是 Visual Studio 2019 的 IntelliSense,仍然显示合理的工具提示(可选)
解决方案
推荐阅读
- multithreading - 缓存一致性和内存屏障之间有什么关系?
- python - 使用 Spark DataFrames 对多个字符串分类特征进行 one-hot 编码
- c# - Lerp 没有平移而是直接移动物体
- terraform - 有没有办法在 terraform 中忽略 vsphere 数据存储端的磁盘配置更改?
- go - Golang - 为什么总是 ItoA 在返回字符串时删除初始 0
- c++ - 一个关于字符串最大子序列的程序
- python - 在几个不同的文件路径上运行循环
- python-3.x - 打印不带括号和逗号的列表和另一个变量
- python - 替换数据框中缺失的日期,我应该使用零、最小日期还是平均值?
- c++ - 为什么 Gun *gun=&machinegun 有效,但 *gun=&machinegun 无效?