将SVN日志消息包含在Doxygen中

Question

有没有办法配置Doxygen来包含SVN的日志作为输出的一部分？基本上我们在提交时会向SVN输入非常严格的日志消息，我希望这些消息在Doxygen输出中有一个部分。

Answer 1

如何使用构建服务器（CruiseControl / Bamboo / TeamCity等）？ 构建服务器将监视svn的更改，构建脚本（例如ant）调用Doxygen作为构建的一部分。我在Java和C＃组合构建上使用这种安排。构建脚本可以使用带有适当选项的“svn log”来获取最新的提交消息。

Answer 2

我不知道一个简单或简单的解决方案，但我认为你可以快速地解决问题。

• 首先，您可以生成HTML文件 从SVN日志中使用 来自的svn2html.xsl样式表 svn2cl tool。如果你不喜欢 它实际上并不难 尽你所能写出类似的东西 read in this blog post。
• 第二，你可以以某种方式修改 Doxygen输出包含一个链接 第一步中生成的html文件。我对此并不了解，但也许doxygen manual page about customization是一个好的开始。
• 第三，你可以写一个小版本 文件的文件 可能会自动执行第一步和第二步 使用make或shell脚本或批处理文件。

不是很优雅，但是一个开始。

Answer 3

我喜欢这个想法，但肯定只有你一次只提交一个SVN文件才会起作用 - 或者doxygen输出会被无关的评论所污染？

我认为可以使用批量更新SVN提交来完成。

您可以提取SVN提交，这些提交将显示已提交的文件以及通过打开SVN日志文件所做的更改注释。因此，我认为你可以编写一个Windows服务或cron作业，通过运行日志文件并构建一个Dictionary或HashTable，每晚构建一个更改的文件列表及其注释。有了这个，有cron / win服务打开提到的每个文件，搜索描述部分的结尾：

* @section DESCRIPTION 
* 
*  
*
**/

并将评论放在此部分中。