在doxygen中,标准的"///\todo stuff"用于标记待办事项.我在MSVC中完成了大部分编码,因此能够在任务列表中看到TODO是很方便的.MSVC使用"// TODO stuff"作为标签.有没有办法让它们一起工作？我找到了任务列表的属性窗格,并尝试将"\ todo"添加到列表中,但它不喜欢"\"字符.我可以让这两个一起工作吗？
编辑:我特别感兴趣的是在Visual Studio 10中找到如何执行此操作.
我有一些C++代码库,用doxygen记录,并使用GNU make构建.版本信息集中在makefile中,我有类似的东西:
VERSION = 1.2.3.4
在我的makefile中,CFLAGS添加以下定义:
CFLAGS + = -DAPP_VERSION = $(版本)
这使我能够在代码中获取版本,如下所示:
#define STR_EXPAND(tok) #tok
#define STR(tok) STR_EXPAND(tok)
int main()
{
cout << "software version is << STR(APP_VERSION) << endl;
}
现在,我想要的是在doxygen生成的html文件中有这个:
当前版本的软件是1.2.3.4
我设法将makefile变量导出到doxygen配置文件中:( 编辑:从makefile调用doxygen,通过'make-doc'目标)
PREDEFINED = APP_VERSION = $(版本)
但是,如果我尝试使用doxygen\mainpage这样的命令,它会失败,因为(当然),宏名称不会在评论中扩展...
/**
\mainpage this is the doc
Current version is $(APP_VERSION) -- or -- ... is APP_VERSION
*/
问题
你知道在doxygen评论中"扩展"这个宏的方法吗？这可以通过对makefile中保存注释的文件进行一些sed处理来完成,但是这可以直接用doxygen解决吗？
其他项目如何处理版本控制(除了VCS提供的自动版本控制工具,我的意思),以版本ID在文件中唯一定义的方式,因此它可以由软件构建系统和文档构建系统获取.
相关:如何显示定义的值