MySQL Doxygen ドキュメントのコンテンツを生成する

#MySQL のソース コードには、Doxygen を使用して書かれた広範な内部ドキュメントが含まれています。この Doxygen コンテンツは https://dev.mysql.com/doc/index-other.html で入手できます。この Doxygen コンテンツは、MySQl ソース配布からローカルに生成できます。これは、次の手順で実行できます。 -

Doxygen のインストール

最初のステップは、Doxygen 1.8.11 以降をインストールすることです。これらのディストリビューションは http://www.doxygen.nl/ から入手できます。

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

shell > doxygen −−version
1.8.13

PlantUML のインストール

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

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

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

上記のコマンドは GUI ウィンドウを開き、コンソールにはエラーは表示されません。

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

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

Graphviz のインストール

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

インストールが完了したら、dot コマンドが使用できるかどうかを確認する必要があります。これは、次のコマンドを使用して確認できます。

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

この手順が完了したら、エラー ログを確認する必要があります。エラー ログは、最上位ディレクトリの doxyerror ファイルにあります。ビルドが正常に実行されると、生成された出力をブラウザーで表示できます。これは、次のコマンドを使用して実行できます。 -

shell> firefox doxygen/html/index.html

以上がMySQL Doxygen ドキュメントのコンテンツを生成するの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。