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
प्लांटUML स्थापित करें
प्लांटयूएमएल स्थापित करने के लिए अगला कदम है। जब यह विंडोज 10 पर स्थापित होता है, तो इसे कम से कम एक बार व्यवस्थापक के रूप में चलाया जाना चाहिए ताकि रजिस्ट्री कुंजियां बनाई जा सकें।
एक व्यवस्थापक कंसोल खोला जा सकता है, और नीचे दिए गए कोड को निष्पादित करने की आवश्यकता है -
shell> java −jar path−to−plantuml.jar
उपरोक्त आदेश कंसोल पर बिना किसी त्रुटि के एक GUI विंडो खोलेगा।
एक बार यह हो जाने के बाद, PLANTUML_JAR_PATH पर्यावरण चर को उस स्थान पर सेट करना होगा जहां PlantUML स्थापित किया गया था। आइए एक उदाहरण देखें -
shell> export PLANTUML_JAR_PATH=path-to-plantuml.jar
ग्राफविज़ इंस्टॉल करें
अगला चरण ग्राफ़विज़ डॉट कमांड को स्थापित करना है।
एक बार यह हो जाने के बाद, डॉट उपलब्धता को सत्यापित करने की आवश्यकता है। यह नीचे दिए गए आदेशों का उपयोग करके किया जा सकता है -
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 ..
सेमेक को पहले क्रियान्वित किया जाता है।
Doxygen दस्तावेज़ तैयार करें
अगला कदम डॉक्सिजन दस्तावेज तैयार करना है। यह निम्न आदेश निष्पादित करके किया जा सकता है -
shell> make doxygen
एक बार ऐसा करने के बाद, त्रुटि लॉग का निरीक्षण किया जाना चाहिए। यह doxyerror फ़ाइल में उपलब्ध है जो कि top−evel निर्देशिका में मौजूद है। एक बार बिल्ड को ठीक से निष्पादित करने के बाद, जेनरेट किए गए आउटपुट को ब्राउज़र पर देखा जा सकता है। यह नीचे दिए गए आदेश का उपयोग करके किया जा सकता है -
shell> firefox doxygen/html/index.html