我的函数有一个不同的参数列表,具体取决于设备功能是否通过#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会忽略不相关的那个吗?或者它仍然会看到两个文档块,并抱怨没有相关的功能?
有没有更好的方法来管理它?谢谢。
发布于 2015-07-01 20:38:25
Doxygen执行一些部分预处理:如果将特定的文档放在if/else部分,则只会显示相关的文档。然而,这真的是一件好事吗?作为一个用户,我可能有兴趣看到每个不同的原型,即使在编译时被禁用。
https://stackoverflow.com/questions/31161130
复制相似问题