Tạo Nội dung Tài liệu Doxygen MySQL

Mã nguồn của MySQL chứa rất nhiều tài liệu nội bộ, được viết bằng Doxygen. Nội dung Doxygen này có sẵn tại https://dev.mysql.com/doc/index-other.html. Nội dung Doxygen này có thể được tạo cục bộ từ bản phân phối nguồn MySQl. Điều này có thể được thực hiện bằng cách làm theo các bước được đề cập bên dưới -

Cài đặt Doxygen

Bước đầu tiên là cài đặt Doxygen 1.8.11 hoặc phiên bản cao hơn của nó. Các bản phân phối có sẵn tại https://www.doxygen.nl/.

Khi nó đã được cài đặt, số phiên bản phải được xác minh. Điều này có thể được thực hiện bằng cách sử dụng lệnh dưới đây -

shell > doxygen −−version
1.8.13

Cài đặt PlantUML

Bước tiếp theo là cài đặt PlantUML. Khi cài đặt này được cài đặt trên Windows 10, nó phải được chạy với tư cách quản trị viên ít nhất một lần để có thể tạo khóa đăng ký.

Có thể mở bảng điều khiển dành cho quản trị viên và mã dưới đây cần được thực thi -

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

Lệnh trên sẽ mở một cửa sổ GUI mà không có bất kỳ lỗi nào trên bảng điều khiển.

Khi điều này được thực hiện, biến môi trường PLANTUML_JAR_PATH phải được đặt thành vị trí mà PlantUML đã được cài đặt. Hãy để chúng tôi xem xét một ví dụ -

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

Cài đặt Graphviz

Bước tiếp theo là cài đặt lệnh Graphviz dot.

Khi điều này đã được thực hiện, tính khả dụng của dấu chấm cần được xác minh. Điều này có thể được thực hiện bằng cách sử dụng các lệnh dưới đây -

shell> which dot
/usr/bin/dot

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

Vị trí của thư mục cấp cao nhất của phân phối nguồn MySQL phải được thay đổi. Điều này có thể được thực hiện bằng cách sử dụng lệnh dưới đây -

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

Cmake được thực thi trước.

Tạo tài liệu về Doxygen

Bước tiếp theo là tạo tài liệu doxygen. Điều này có thể được thực hiện bằng cách thực hiện lệnh dưới đây -

shell> make doxygen

Khi điều này được thực hiện, nhật ký lỗi phải được kiểm tra. Điều này có sẵn trong tệp doxyerror có trong thư mục evel trên cùng. Khi quá trình xây dựng đã được thực thi đúng cách, đầu ra được tạo có thể được xem trên trình duyệt. Điều này có thể được thực hiện bằng cách sử dụng lệnh dưới đây -

shell> firefox doxygen/html/index.html