Question

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

e.g。

#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部分中，则只会显示相关文档。但是，这真的是件好事吗？作为用户，我可能有兴趣看到每个不同的原型，即使在编译时被禁用。