代码之家  ›  专栏  ›  技术社区  ›  Medran

将SVN日志消息包含到doxygen中

  •  4
  • Medran  · 技术社区  · 16 年前

    是否有任何方法可以配置doxygen将来自SVN的文件日志作为输出的一部分?基本上,我们在提交时将相当严格的日志消息输入到SVN中,我希望这些消息在doxygen输出中有一个部分。

    3 回复  |  直到 12 年前
        1
  •  2
  •   Sebastian    16 年前

    我不知道一个简单或简单的解决办法,但我认为你可以很快地把一些东西拼凑在一起。

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

    不是很优雅,只是一个开始。

        2
  •  2
  •   phlip    16 年前

    如何使用构建服务器(CruiseControl/Bamboo/Teamcity等)? 构建服务器将监视SVN的更改,构建脚本(例如ant)将作为构建的一部分调用doxygen。我在JAVA和C的组合构建中使用这个安排。构建脚本可以使用带有适当选项的“SVN日志”来获取最新的提交消息。

        3
  •  0
  •   amelvin    16 年前

    我喜欢这个想法,但是可以肯定的是,只有在一次只提交SVN一个文件的情况下,它才会起作用——或者,doxygen输出中会充斥着不相关的注释?

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

    您可以提取SVN提交,它将显示提交的文件以及通过打开SVN日志文件所做的更改注释。所以我认为你可以编写一个windows服务或cron作业,通过运行日志文件并构建一个字典或哈希表来构建一个被更改的文件及其注释的列表。有了它,cron/win服务就可以打开上面提到的每个文件,搜索描述部分的结尾:

    * @section DESCRIPTION 
    * 
    *  
    *
    **/
    

    并将注释放在本节中。