การสร้างเนื้อหาเอกสาร MySQL Doxygen

ซอร์สโค้ดของ MySQL มีเอกสารภายในจำนวนมาก ซึ่งเขียนโดยใช้ Doxygen เนื้อหา Doxygen นี้มีให้ที่ https://dev.mysql.com/doc/index-other.html เนื้อหา Doxygen นี้สามารถสร้างได้ในเครื่องจากการกระจายแหล่งที่มาของ MySQl ซึ่งสามารถทำได้โดยทำตามขั้นตอนที่กล่าวถึงด้านล่าง -

ติดตั้ง Doxygen

ขั้นตอนแรกคือการติดตั้ง Doxygen 1.8.11 หรือเวอร์ชันที่สูงกว่า การแจกแจงมีอยู่ที่ https://www.doxygen.nl/

เมื่อติดตั้งแล้วจะต้องตรวจสอบหมายเลขเวอร์ชัน สามารถทำได้โดยใช้คำสั่งด้านล่าง −

shell > doxygen −−version
1.8.13

ติดตั้ง PlantUML

ขั้นตอนต่อไปคือการติดตั้ง PlantUML เมื่อสิ่งนี้ได้รับการติดตั้งบน Windows 10 ควรจะเรียกใช้ในฐานะผู้ดูแลระบบอย่างน้อยหนึ่งครั้งเพื่อให้สามารถสร้างคีย์รีจิสทรีได้

สามารถเปิดคอนโซลผู้ดูแลระบบและต้องดำเนินการโค้ดด้านล่าง -

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

คำสั่งดังกล่าวจะเปิดหน้าต่าง GUI โดยไม่มีข้อผิดพลาดใดๆ บนคอนโซล

เมื่อดำเนินการเสร็จแล้ว จะต้องตั้งค่าตัวแปรสภาพแวดล้อม PLANTUML_JAR_PATH เป็นตำแหน่งที่ติดตั้ง PlantUML เรามาดูตัวอย่างกัน −

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

ติดตั้ง Graphviz

ขั้นตอนต่อไปคือการติดตั้งคำสั่ง Graphviz dot

เมื่อดำเนินการเสร็จแล้ว จะต้องตรวจสอบความพร้อมใช้งานของจุด สามารถทำได้โดยใช้คำสั่งด้านล่าง -

shell> which dot
/usr/bin/dot

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

ต้องเปลี่ยนตำแหน่งของไดเร็กทอรีระดับบนสุดของการแจกแจงซอร์ส MySQL สามารถทำได้โดยใช้คำสั่งด้านล่าง −

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

คำสั่ง cmake จะถูกดำเนินการก่อน

สร้างเอกสาร Doxygen

ขั้นตอนต่อไปคือการสร้างเอกสารประกอบด็อกซีเจน ซึ่งสามารถทำได้โดยดำเนินการคำสั่งด้านล่าง −

shell> make doxygen

เมื่อดำเนินการเสร็จแล้ว จะต้องตรวจสอบบันทึกข้อผิดพลาด มีอยู่ในไฟล์ doxyerror ซึ่งอยู่ในไดเร็กทอรีระดับบนสุด เมื่อบิลด์ได้รับการดำเนินการอย่างถูกต้องแล้ว เอาต์พุตที่สร้างขึ้นสามารถดูได้บนเบราว์เซอร์ สามารถทำได้โดยใช้คำสั่งด้านล่าง −

shell> firefox doxygen/html/index.html