Mã nguồn MySQL chứa nhiều tài liệu nội bộ viết bằng Doxygen. Nội dung Doxygen có tại https://dev.mysql.com/doc/index-other.html. Có thể tạo nội dung Doxygen cục bộ từ bản phân phối source MySQL. Làm theo các bước:
Cài đặt Doxygen
Bước 1: Cài Doxygen 1.8.11 hoặc cao hơn. Phân phối tại https://www.doxygen.nl/.
Sau khi cài, kiểm tra phiên bản:
shell > doxygen --version 1.8.13
Cài đặt PlantUML
Bước 2: Cài PlantUML. Trên Windows 10, nên chạy as administrator ít nhất 1 lần để tạo registry key.
Mở console admin, chạy:
shell> java -jar path-to-plantuml.jar
Lệnh trên mở cửa sổ GUI, không lỗi trên console.
Sau đó, đặt biến môi trường PLANTUML_JAR_PATH tới vị trí cài PlantUML:
shell> export PLANTUML_JAR_PATH=path-to-plantuml.jar
Cài đặt Graphviz
Bước 3: Cài lệnh dot của Graphviz.
Sau khi cài, kiểm tra dot:
shell> which dot /usr/bin/dot shell> dot -V dot - graphviz version 2.28.0 (20130928.0220)
Chuyển đến thư mục cấp cao nhất của source distribution MySQL:
shell> cd your-mysql-source-directory shell> mkdir bld shell> cd bld shell> cmake ..
Chạy cmake trước.
Tạo tài liệu Doxygen
Bước 4: Tạo tài liệu doxygen bằng lệnh:
shell> make doxygen
Sau khi xong, kiểm tra error log. Có sẵn trong file doxyerror tại thư mục top-level. Sau khi build thành công, xem output trên trình duyệt:
shell> firefox doxygen/html/index.html