SystemVerilog、VerilogをDoxygenでドキュメント化する

VHDLはDoxygenでドキュメント化できるが、VerilogもDoxygenでドキュメント化したいと思っていた。以前、Verification Engineerの戯言さんの”Doxygen Filter for System Verilog 2.3.0 Released”の記事を見て、気になっていたので、SystemVerilog、VerilogをDoxygenでドキュメント化してみることにした。この記事はその覚書だ。

Doxygenはバージョン1.6.3を使用している。まずは、Doxygen Tools (including a Filter for SystemVerilog) のWebページからDoxygen Toolsをダウンロードする。ダウンロードし解凍すると2.6.0.r130というフォルができて、下図のフォルダが生成される。


これをDoxygenのフォルダにコピーする。下図がコピーしたあとの状態だ。


ドキュメント化するVerilogファイルは、”Spartan3A Starter KitのDDR2 SDRAMコントローラのバーストテストのプロジェクト”のVerilogファイルとする。

Doxygenを使う前にスクリプトはperlを使用しているので、Windowsにperlが入っていない場合は、perlをインストールする。私は、ActivePerlを使用した。

Doxywizardをメニューから起動する。Wizardで設定を行い、Expertタブを設定する。
ExpertタブのBuildの項目でEXTRACT_ALLにチェックが入っていることを確認する。


ExpertタブのInputの項目でFILE_PATTERNSに .v と .sv の拡張子を追加する。


ExpertタブのInputの項目のINPUT_FILTERの項目にdoxygen/filter/idv_doxyfilter_sv.pl を指定する。FILE_PATTERNSの項目に .v と .sv の拡張子を追加する。


このidv_doxyfilter_sv.plスクリプトは.vと(たぶん）.svのみ解析するようなので、.vh のインクルードファイルがあると、そこは解析されない。そこで、ddr2_burst_test/Synth112の下のddr2_cont_parameters.vhをddr2_cont_parameters.vにコピーした。
これでRunタブからdoxygenをRUNすると、Verilogファイルがドキュメント化できた。

ここにドキュメント化したhtmlファイルを置いておく。
Doxygenの設定ファイルのサンプルをここに置いておく。このファイルを自分のパソコンにコピーして、Doxygen GUI frontendウインドウのFileメニューからOpen...を選んで、Doxygenの設定ファ イルのサンプルを選択すれば、私の行った設定を再現できる。その場合は、最低でも、WizardタブのSpecify the directory to scan for source code のSource cod directry とDestination directory、ExpertタブのInput項目のINPUT_FILTERのフォルダ名を変更する必要がある。

SystemVerilogはまだ本格的に書いたことがないので分からないが、SystemVerilogのドキュメント化ができると思う。