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 कमांड इंस्टॉल करना है।
एक बार यह हो जाने पर, 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
