MySQL ソースコードには、Doxygen を使用して記述された内部ドキュメントが含まれます。 生成された Doxygen コンテンツは、https://dev.mysql.com/doc/index-other.html で入手できます。 次の手順を使用して、このコンテンツを MySQL ソース配布からローカルに生成することもできます:
-
doxygen 1.8.11 以上をインストールします。 配布は、http://www.doxygen.nl/ で入手できます。
doxygen のインストール後、バージョン番号を確認します:
shell> doxygen --version 1.8.13 -
PlantUML をインストールします。
PlantUML を Windows (Windows 10 でテスト済) にインストールする場合、レジストリキーを作成するには、少なくとも管理者として実行する必要があります。 管理者コンソールを開き、次のコマンドを実行します:
shell> java -jar path-to-plantuml.jarこのコマンドは GUI ウィンドウを開き、コンソールでエラーを返しません。
-
PLANTUML_JAR_PATH環境を、PlantUML をインストールした場所に設定します。 例:shell> export PLANTUML_JAR_PATH=path-to-plantuml.jar -
Graphviz dot コマンドをインストールします。
Graphviz のインストール後、
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 ..次に、doxygen ドキュメントを生成します:
shell> make doxygenエラーログを調べます。 これは、最上位ディレクトリの
doxyerror.logファイルで使用できます。 ビルドが正常に実行されたと仮定して、ブラウザを使用して生成された出力を表示します。 例:shell> firefox doxygen/html/index.html