MySQL সোর্স কোডে Doxygen দিয়ে লেখা প্রচুর ইন্টারন্যাল ডকুমেন্টেশন রয়েছে। এই Doxygen কন্টেন্ট উপলব্ধ: https://dev.mysql.com/doc/index-other.html। MySQL সোর্স ডিস্ট্রিবিউশন থেকে লোকালি এই Doxygen কন্টেন্ট জেনারেট করা যায় নিচের ধাপগুলো ফলো করে।
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 কমান্ড ইনস্টল করুন।
এরপর 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 ডকুমেন্টেশন জেনারেট
Doxygen ডকুমেন্টেশন জেনারেট করতে নিচের কমান্ড এক্সিকিউট করুন:
shell> make doxygen
এক্সিকিউশনের পর এরর লগ যাচাই করুন। এটি টপ-লেভেল ডিরেক্টরির doxyerror ফাইলে থাকে। বিল্ড সফল হলে জেনারেটেড আউটপুট ব্রাউজারে দেখুন:
shell> firefox doxygen/html/index.html
