การสร้าง MySQL Doxygen Documentation Content

MySQL source code มี internal documentation เขียนด้วย Doxygen เรียกดูได้ที่ https://dev.mysql.com/doc/index-other.html สร้าง locally จาก MySQL source distribution ได้ดังนี้:

1. Install Doxygen

ติดตั้ง Doxygen 1.8.11+ จาก https://www.doxygen.nl/ ตรวจสอบ version:

shell > doxygen --version
1.8.13

2. Install PlantUML

ติดตั้ง PlantUML บน Windows 10 รัน as administrator ครั้งแรกเพื่อสร้าง registry keys

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

คำสั่งจะเปิด GUI window โดยไม่มี errors

Set PLANTUML_JAR_PATH environment variable:

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

3. Install Graphviz

ติดตั้ง Graphviz dot command ตรวจสอบ dot availability:

shell> which dot
/usr/bin/dot
shell> dot -V
dot - graphviz version 2.28.0 (20130928.0220)

4. Generate Doxygen Documentation

เปลี่ยนไป top-level directory ของ MySQL source distribution:

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

จากนั้น generate documentation:

shell> make doxygen

ตรวจสอบ error log ใน doxyerror file (top-level directory) หาก build สำเร็จ เรียกดู output บน browser:

shell> firefox doxygen/html/index.html