MySQLDoxygenドキュメントコンテンツの生成

MySQLのソースコードには、Doxygenを使用して記述された多くの内部ドキュメントが含まれています。このDoxygenコンテンツは、https：//dev.mysql.com/doc/index-other.htmlで入手できます。このDoxygenコンテンツは、MySQlソースディストリビューションからローカルで生成できます。これは、以下の手順に従うことで実行できます-

Doxygenをインストールする

最初のステップは、Doxygen1.8.11以降のバージョンをインストールすることです。ディストリビューションはhttps://www.doxygen.nl/で入手できます。

インストールしたら、バージョン番号を確認する必要があります。これは、以下のコマンドを使用して実行できます-

shell > doxygen −−version
1.8.13

PlantUMLをインストール

次のステップはPlantUMLをインストールすることです。これをWindows10にインストールする場合は、レジストリキーを作成できるように、少なくとも1回は管理者として実行する必要があります。

管理者コンソールを開くことができ、以下のコードを実行する必要があります-

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

上記のコマンドは、コンソールでエラーなしでGUIウィンドウを開きます。

これが完了したら、PLANTUML_JAR_PATH環境変数をPlantUMLがインストールされた場所に設定する必要があります。例を見てみましょう-

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

Graphvizをインストールする

次のステップは、Graphvizdotコマンドをインストールすることです。

これが完了したら、ドットの可用性を確認する必要があります。これは、以下のコマンドを使用して実行できます-

shell> which dot
/usr/bin/dot

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

MySQLソースディストリビューションの最上位ディレクトリの場所を変更する必要があります。これは、以下のコマンドを使用して実行できます-

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

最初にcmakeが実行されます。

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

次のステップは、doxygenドキュメントを生成することです。これは、以下のコマンドを実行することで実行できます-

shell> make doxygen

これが完了したら、エラーログを検査する必要があります。これは、top-evelディレクトリにあるdoxyerrorファイルで利用できます。ビルドが適切に実行されると、生成された出力をブラウザーで表示できます。これは、以下のコマンドを使用して実行できます-

shell> firefox doxygen/html/index.html