Hasilkan kandungan dokumentasi MySQL Doxygen

Kod sumber MySQL mengandungi dokumentasi dalaman yang luas, yang ditulis menggunakan Doxygen. Kandungan Doxygen ini boleh didapati di https://dev.mysql.com/doc/index-other.html. Kandungan Doxygen ini boleh dijana secara tempatan daripada pengedaran sumber MySQl. Ini boleh dilakukan dengan mengikuti langkah -

Pasang Doxygen

Langkah pertama ialah memasang Doxygen 1.8.11 atau lebih tinggi. Pengagihan ini boleh didapati di http://www.doxygen.nl/.

Selepas pemasangan, nombor versi mesti disahkan. Ini boleh dilakukan menggunakan arahan berikut -

shell > doxygen −−version
1.8.13

Install PlantUML

Langkah seterusnya ialah memasang PlantUML. Apabila ia dipasang pada Windows 10, ia harus dijalankan sebagai pentadbir sekurang-kurangnya sekali supaya kunci pendaftaran boleh dibuat.

Konsol pentadbir boleh dibuka dan kod berikut perlu dilaksanakan -

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

Arahan di atas akan membuka tetingkap GUI dan konsol tidak akan menunjukkan sebarang ralat.

Selepas melengkapkan langkah ini, anda perlu menetapkan pembolehubah persekitaran PLANTUML_JAR_PATH ke lokasi pemasangan PlantUML. Mari lihat contoh −

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

Memasang Graphviz

Langkah seterusnya ialah memasang arahan Graphviz dot.

Selepas pemasangan selesai, anda perlu mengesahkan ketersediaan arahan titik. Ini boleh disahkan menggunakan arahan berikut:

shell> which dot
/usr/bin/dot

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

Lokasi direktori peringkat atas pengedaran kod sumber MySQL mesti ditukar. Ini boleh ditukar menggunakan arahan berikut −

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

Mula-mula laksanakan cmake.

Jana dokumentasi Doxygen

Langkah seterusnya ialah menjana dokumentasi doksigen. Ini boleh dilakukan dengan melaksanakan arahan berikut -

shell> make doxygen

Setelah anda melengkapkan langkah ini, anda perlu menyemak log ralat. Log ralat boleh didapati dalam fail doxyerror dalam direktori peringkat atas. Setelah binaan dilaksanakan dengan jayanya, output yang dihasilkan boleh dilihat pada penyemak imbas. Ini boleh dilakukan menggunakan arahan berikut −

shell> firefox doxygen/html/index.html

Atas ialah kandungan terperinci Hasilkan kandungan dokumentasi MySQL Doxygen. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!