首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >如何记录可选参数

如何记录可选参数
EN

Stack Overflow用户
提问于 2015-07-01 20:19:38
回答 1查看 308关注 0票数 3

我的函数有一个不同的参数列表,具体取决于设备功能是否通过#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会忽略不相关的那个吗?或者它仍然会看到两个文档块,并抱怨没有相关的功能?

有没有更好的方法来管理它?谢谢。

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2015-07-01 20:38:25

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

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

票数 2
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/31161130

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档