Qt 5.11 - Getting Started with QDoc

QDoc से आरंभ करना




qt

QDoc से आरंभ करना

Qt HTML और DITA XML स्वरूपों में सेट किए गए अपने दस्तावेज़ उत्पन्न करने के लिए QDoc का उपयोग करता है। QDoc QDoc टिप्पणियों से प्रलेखन उत्पन्न करने के लिए कॉन्फ़िगरेशन फ़ाइलों का एक सेट का उपयोग करता है। टिप्पणियों में उन प्रकारों को topics कहा जाता topics जो यह निर्धारित करते हैं कि क्या टिप्पणी एक वर्ग प्रलेखन या संपत्ति प्रलेखन है। अंतिम आउटपुट के लेआउट और स्वरूपण को बढ़ाने के लिए एक टिप्पणी भी हो सकती है।

Qdoc के साथ प्रलेखन उत्पन्न करने के लिए तीन आवश्यक सामग्रियां हैं:

  • QDoc बाइनरी
  • qdocconf विन्यास फाइल
  • C++ , QML और .qdoc फ़ाइलों में दस्तावेज़ीकरण

नोट: Qt 5.11 से, QDoc को C ++ हैडर और सोर्स फाइल्स को पार्स करने के लिए LLVM 3.9 से QDoc आवश्यकता होती है, और फंक्शन सिग्नेचर को \fn कमांड में पार्स करने के लिए। विवरण के लिए QDoc के लिए इंस्टॉलिंग क्लैंग देखें।

यह खंड एक प्रलेखन सेट बनाने के लिए बुनियादी आवश्यकताओं को कवर करने का इरादा रखता है। इसके अतिरिक्त, गाइड गैर-सी ++ एपीआई दस्तावेज़ीकरण के साथ-साथ क्यूएमएल प्रलेखन के लिए विशेष विचार और विकल्प प्रस्तुत करता है। अंत में, गाइड एक नमूना परियोजना प्रलेखन और QML प्रकार के प्रलेखन का एक उदाहरण प्रदान करेगा।

विशिष्ट QDoc जानकारी के लिए, QDoc से परामर्श करें।

अध्याय

  1. QDoc के लिए क्लैंग स्थापित करना
  2. QDoc विन्यास फाइल बनाना
  3. लेखन दस्तावेज़
  4. प्रलेखन की श्रेणियाँ
  5. QML प्रलेखन उदाहरण