如何记录可选参数

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 会忽略不相关的吗？还是它仍然会看到两个文档块并抱怨没有相关功能？

是否有更好的管理方法？谢谢

Answer 1

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

How can I document optional parameters