MySQLのDoxygenドキュメントをローカル環境で生成する手順

MySQLのソースコードには、Doxygenを用いて記述された内部ドキュメントが数多く含まれています。公式のDoxygenドキュメントは https://dev.mysql.com/doc/index-other.html で公開されていますが、MySQLのソースディストリビューションがあれば、ローカル環境でも同じドキュメントを自分で生成することが可能です。本記事では、その具体的な手順を順を追って解説します。

1. Doxygenをインストールする

最初のステップは、Doxygen 1.8.11 以降のインストールです。配布ファイルは公式サイト https://www.doxygen.nl/ からダウンロードできます。

インストールが完了したら、バージョン番号を必ず確認しておきましょう。確認は以下のコマンドで行えます。

shell> doxygen --version
1.8.13

2. PlantUMLをインストールする

次に、PlantUMLをインストールします。Windows 10 環境にインストールした場合は、レジストリキーが作成されるよう、少なくとも1回は管理者として実行する必要があります。

管理者権限でコンソールを開き、以下のコマンドを実行してください。

shell> java -jar path-to-plantuml.jar

このコマンドを実行すると、コンソールにエラーが表示されることなくGUIウィンドウが開きます。問題なく起動できれば準備OKです。

続いて、PlantUMLを配置した場所を示す環境変数 PLANTUML_JAR_PATH を設定します。設定例は以下の通りです。

shell> export PLANTUML_JAR_PATH=path-to-plantuml.jar

3. Graphvizをインストールする

次のステップは、Graphviz の dot コマンドのインストールです。

インストール後、dot コマンドが利用できる状態になっているかを、以下のコマンドで確認します。

shell> which dot
/usr/bin/dot

shell> dot -V
dot - graphviz version 2.28.0 (20130928.0220)

続いて、MySQLソースディストリビューションのトップレベルディレクトリに移動し、ビルド用ディレクトリを作成したうえで cmake を実行します。

shell> cd your-mysql-source-directory
shell> mkdir bld
shell> cd bld
shell> cmake ..

4. Doxygenドキュメントを生成する

準備が整ったら、いよいよDoxygenドキュメントを生成します。以下のコマンドを実行してください。

shell> make doxygen

ビルド実行後は、エラーログの確認を忘れないようにしましょう。ログはトップレベルディレクトリに作成される doxyerror ファイルに出力されます。ビルドが正常に完了したら、生成されたドキュメントをブラウザで閲覧できます。

shell> firefox doxygen/html/index.html

まとめ

以上の手順で、MySQLの内部構造を詳しく解説するDoxygenドキュメントをローカル環境で生成できます。ソースコードを読み解く際や、MySQL開発への貢献を検討する際に、非常に役立つリソースとなるでしょう。