DoxygenとJenkinsを連携させてみた。

前回までの記事で、Doxygenの基本的な使い方を書いた。

Doxygenでドキュメント管理しても、実は見ないことのほうが多かったりする。その理由は、

目につく場所にないから
ソースコードを修正するたびにdoxygenファイルを作り直すのが面倒だから
ソースの修正がドキュメントに反映されていないから

などなど、考えられるが、Jenkinsを利用して、Jenkinsジョブを流すたびにドキュメントを更新し、さらにはJenkinsから閲覧できるようにすれば、上に上げた課題は解決するかも。

というわけで、JenkinsとDoxygenを連携してみる。

Doxygen Pluginのインストール

JenkinsにはDoxygen Pluginというものがあるので、インストールする。

[Jenkinsの管理] > [プラグインの管理] からDoxygen Plugeinを選択して、ダウンロードとインストール。

インストールできたらジョブの[設定] からビルドのDoxygenの生成コマンドを追加。

ex.) doxygen doxygen.conf

[ビルド後の処理の追加]から[Publish Doxygen]を選択。

doxygenの設定ファイルを指定する。

画像なくなりました

ビルドを実行して、Doxygenファイルを生成してみる。

DoxyGen HTMLというメニューが現れて、リンク先からDoxygenを閲覧することができる。

注意: こんなエラーがでたら、Doxygenのフォルダパスを指定している。

フォルダではなくて、Doxyfileを指定する。

Publishing Doxygen HTML results.
FATAL: error
<a href="https://stacktrace.jenkins-ci.org/search?query=java.io.FileNotFoundException">java.io.FileNotFoundException</a>: C:\Users\TSUNEMICHI\Dropbox\src\mock_study\html (アクセスが拒否されました。)
	at java.io.FileInputStream.open(Native Method)
	at java.io.FileInputStream.&lt;init&gt;(Unknown Source)
	at hudson.plugins.doxygen.DoxygenDirectoryParser.loadDoxyFile(DoxygenDirectoryParser.java:208)
	at hudson.plugins.doxygen.DoxygenDirectoryParser.retrieveDoxygenDirectoryFromDoxyfile(DoxygenDirectoryParser.java:345)
	at hudson.plugins.doxygen.DoxygenDirectoryParser.invoke(DoxygenDirectoryParser.java:53)
	at hudson.plugins.doxygen.DoxygenDirectoryParser.invoke(DoxygenDirectoryParser.java:14)
	at hudson.FilePath.act(FilePath.java:842)
	at hudson.FilePath.act(FilePath.java:824)
	at hudson.plugins.doxygen.DoxygenArchiver._perform(DoxygenArchiver.java:219)
	at hudson.plugins.doxygen.DoxygenArchiver.perform(DoxygenArchiver.java:176)
	at hudson.tasks.BuildStepMonitor$2.perform(BuildStepMonitor.java:27)
	at hudson.model.AbstractBuild$AbstractBuildExecution.perform(AbstractBuild.java:717)
	at hudson.model.AbstractBuild$AbstractBuildExecution.performAllBuildSteps(AbstractBuild.java:692)
	at hudson.model.Build$BuildExecution.post2(Build.java:183)
	at hudson.model.AbstractBuild$AbstractBuildExecution.post(AbstractBuild.java:639)
	at hudson.model.Run.execute(Run.java:1527)
	at hudson.model.FreeStyleBuild.run(FreeStyleBuild.java:46)
	at hudson.model.ResourceController.execute(ResourceController.java:88)
	at hudson.model.Executor.run(Executor.java:236)
Build step 'Publish Doxygen' changed build result to FAILURE

Doxygen Pluginのインストール#

Doxygen Pluginのインストール