Doxygen执行的API

时间:2011-01-25 05:56:10

标签: api doxygen

每当我将源代码插入代码库时,我都希望自动执行Doxygen。我可以在我的java代码中使用doxygen的api /接口来启动它的执行吗?

2 个答案:

答案 0 :(得分:2)

Doxygen本身是通过执行命令行命令启动的,因此您只需要在签入时执行命令。您没有说任何关于SCC工具,开发环境或您正在使用的操作系统的内容,因此很难给出具体的答案。

执行此操作的常用方法是使用运行持续集成的构建服务器。也就是说,当您签入代码时,构建服务器将注意到签入,获取新代码,然后执行构建(在本例中为Doxygen文档)。有many tools available可以自动化PC来构建构建服务器。使用哪一个取决于您正在使用的操作系统和源代码控制包。 (如果您没有/想要专用的构建服务器,您也可以在后台运行这样的工具在自己的PC上。)

如果您只是想在办理登机手续时在自己的电脑上进行构建,那么您可以调查源控制软件,看看是否可以通知您办理登机手续。某些SCC可能会为某些事件执行脚本或命令,因此可以让它为您执行命令。

最后,很多人只是在他们的开发环境中设置了一个执行Doxygen的工具/宏,然后他们手动运行它。在Visual Studio(例如)中,您甚至可以编写一个宏来执行Check in并从单个按键执行Doxygen。

答案 1 :(得分:0)

如果你想用doxygen更多控制,你还必须生成xml文件并创建一个程序来分析xml输出文件以检查所有约束,并在违反constaint时停止构建。

这项技术需要一些开发工作,但这是我知道用doxygen做你想要的唯一方法。