c - 如何记录可选参数

Question

我的函数具有不同的参数列表，具体取决于是否通过 #define 常量 SMBSUS_INH 启用设备功能

例如

#ifndef SMBUS_INH
    handle initHandle(foo_t foo, SMB_Info_t smbInfo, bar_t bar);
#else
    handle initHandle(foo_t foo, bar_t bar);
#endif

如何正确记录这一点？

如果我写文档两次，每次在每个 #if...else 子句中，doxygen 会忽略不相关的吗？或者它仍然会看到两个文档 block 并提示没有相关功能吗？

有更好的方法来管理这个吗？谢谢。

Answer 1

Doxygen 会进行一些部分预处理:如果您将特定文档放在 if/else 部分中，则只会显示相关文档。然而，这真的是一件好事吗？作为用户，我可能有兴趣查看每个不同的原型(prototype)，即使在编译时禁用。

来源:http://www.doxygen.nl/manual/preprocessing.html