Generieren Sie MySQL Doxygen-Dokumentationsinhalte

Der Quellcode von MySQL enthält eine umfangreiche interne Dokumentation, die mit Doxygen geschrieben wurde. Dieser Doxygen-Inhalt ist unter https://dev.mysql.com/doc/index-other.html verfügbar. Dieser Doxygen-Inhalt kann lokal aus der MySQL-Quelldistribution generiert werden. Dies können Sie tun, indem Sie die Schritte befolgen:

Doxygen installieren

Der erste Schritt besteht darin, Doxygen 1.8.11 oder höher zu installieren. Diese Distributionen sind unter http://www.doxygen.nl/ verfügbar.

Nach der Installation muss die Versionsnummer überprüft werden. Dies kann mit dem folgenden Befehl erfolgen: -

shell > doxygen −−version
1.8.13

Install PlantUML

Der nächste Schritt besteht darin, PlantUML zu installieren. Bei der Installation unter Windows 10 sollte es mindestens einmal als Administrator ausgeführt werden, damit Registrierungsschlüssel erstellt werden können.

Die Administratorkonsole kann geöffnet werden und der folgende Code muss ausgeführt werden -

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

Der obige Befehl öffnet ein GUI-Fenster und die Konsole zeigt keine Fehler an.

Nach Abschluss dieses Schritts müssen Sie die Umgebungsvariable PLANTUML_JAR_PATH auf den Speicherort der PlantUML-Installation setzen. Sehen wir uns ein Beispiel an:

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

Installieren von Graphviz

Der nächste Schritt besteht darin, den Graphviz-Punktbefehl zu installieren.

Nachdem die Installation abgeschlossen ist, müssen Sie die Verfügbarkeit des Punktbefehls überprüfen. Dies kann mit dem folgenden Befehl überprüft werden:

shell> which dot
/usr/bin/dot

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

Der Speicherort des obersten Verzeichnisses der MySQL-Quellcodeverteilung muss geändert werden. Dies kann mit dem folgenden Befehl geändert werden: −

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

Führen Sie zunächst cmake aus.

Doxygen-Dokumentation erstellen

Der nächste Schritt besteht darin, eine Doxygen-Dokumentation zu erstellen. Dies kann durch Ausführen des folgenden Befehls erfolgen:

shell> make doxygen

Sobald Sie diesen Schritt abgeschlossen haben, müssen Sie das Fehlerprotokoll überprüfen. Das Fehlerprotokoll befindet sich in der Datei „doxyerror“ im Verzeichnis der obersten Ebene. Sobald der Build erfolgreich ausgeführt wurde, kann die generierte Ausgabe im Browser angezeigt werden. Dies kann mit dem folgenden Befehl erfolgen: −

shell> firefox doxygen/html/index.html

Das obige ist der detaillierte Inhalt vonGenerieren Sie MySQL Doxygen-Dokumentationsinhalte. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!