4

有什么方法可以配置 Doxygen 以将来自 SVN 的日志作为输出的一部分包含在文件中？基本上，当我们提交时，我们会在 SVN 中输入非常严格的日志消息，我希望这些消息在 Doxygen 输出中有一个部分。

4

3 回答 3

2

我不知道一个简单或容易的解决方案，但我认为你可以快速破解一些东西。

  • 首先，您可以使用svn2cl 工具中的 svn2html.xsl 样式表从 SVN 日志生成一个 HTML 文件 。如果你不喜欢它，实际上写这样的东西并不难，你可以 在这篇博文中读到。
  • 其次，您可以以某种方式修改 Doxygen 输出以包含指向在第一步中生成的 html 文件的链接。我对此了解不多，但也许关于定制的 doxygen 手册页是一个好的开始。
  • 第三，您可以为您的文档编写一个小的构建文件，该文件可以使用 make 或 shell 脚本或批处理文件自动执行第一步和第二步。

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

于 2010-03-08T23:11:43.270 回答
2

使用构建服务器（CruiseControl/Bamboo/TeamCity 等）怎么样？构建服务器会监控 svn 的变化，构建脚本（例如 ant）调用 Doxygen 作为构建的一部分。我在 Java 和 C# 组合构建中使用这种安排。构建脚本可以使用适当的选项使用“ SVN Log”来获取最新的提交消息。

于 2010-03-08T23:07:10.537 回答
0

我喜欢这个想法，但肯定只有在一次只提交 SVN 一个文件的情况下它才会起作用 - 或者 doxygen 输出中会充斥着不相关的评论？

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

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

* @section DESCRIPTION 
* 
*  
*
**/

并将评论放在本节中。

于 2010-03-08T23:12:38.510 回答