如何解决宏内的Doxygen注释
我的问题如下:我有一组具有相同参数的构造函数文件。我在每个文件中使用的宏中定义了构造函数的参数。例如,以下构造函数:Planar(BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3);
使用BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3宏来扩展Planar构造函数的参数:
#define BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3 \\
size_t height,\\
size_t width,\\
size_t stride,\\
size_t effectiveChannels,\\
BSPF_UTILS::bspf_8u* buffer
我的问题如下:我想为使用相同宏的所有构造函数提供相同的Doxygen文档,换句话说,我只想为共享同一宏的构造函数编写一次文档。
我怎样才能做到这一点 ?
我试图编写一个宏(使用参数的构造函数名称),但是由于Doxygen扩展了该宏而没有换行符,所以它不起作用。
有什么好办法吗?
感谢您的回答。
解决方法
宏总是在没有换行的情况下扩展的,这与doxygen无关。但是,解决方案相对简单:
有一个额外的文本文件(
\"BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3.txt\"
或类似文件),其中包含特定于该定义的注释,另外一个
#define BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3_INCLUDE \\
\"BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3.txt\"
最后以以下方式使用它:
// your .cpp
#include BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3_INCLUDE
Planaer::Planar(BSPF_IMAGE_FORMAT_STD_CONST_PARAMS_3){
}
只需将.txt的内容复制并粘贴到您的.cpp文件中即可,仅此而已。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。