Qt 5.11 - Supporting Derived Projects

व्युत्पन्न परियोजनाओं का समर्थन




qt

व्युत्पन्न परियोजनाओं का समर्थन

कुछ कॉन्फ़िगरेशन चर आपको Qt- आधारित परियोजनाओं का समर्थन करने के लिए QDoc का उपयोग करने की अनुमति देते हैं। वे आपकी परियोजना को ऑनलाइन Qt दस्तावेज़ीकरण से लिंक करने की अनुमति देते हैं, जिसका अर्थ है कि QDoc किसी भी स्पष्ट लिंकिंग कमांड के बिना, वर्ग संदर्भ प्रलेखन के लिंक बनाने में सक्षम होगा।

विवरण

विवरण चर संबंधित परियोजना का एक छोटा विवरण रखता है।

project भी देखें

अनुक्रमणिका

indexes चर अनुक्रमणिका फ़ाइलों को सूचीबद्ध करता है जिनका उपयोग संदर्भ उत्पन्न करने के लिए किया जाएगा।

उदाहरण के लिए। व्युत्पन्न Qt प्रोजेक्ट बनाने के लिए Qt संदर्भ दस्तावेज़ के लिंक होते हैं, आपको संबंधित अनुक्रमणिका फ़ाइल निर्दिष्ट करने की आवश्यकता होती है:

indexes = $QTDIR/doc/html/qt.index

project और url भी देखें।

परियोजना

project चर .qdocconf फ़ाइल से संबद्ध प्रोजेक्ट के लिए एक नाम प्रदान करता है।

प्रोजेक्ट का नाम संबंधित प्रोजेक्ट की इंडेक्स फ़ाइल के लिए फ़ाइल नाम बनाने के लिए उपयोग किया जाता है।

project = QtCreator

यह एक इंडेक्स फ़ाइल का कारण qtcreator.index जिसे qtcreator.index कहा जाता है।

description और indexes भी देखें।

यूआरएल

url वैरिएबल वर्तमान प्रोजेक्ट से जुड़े संदर्भ प्रलेखन के लिए आधार URL रखता है।

URL प्रोजेक्ट के लिए जनरेट किए गए इंडेक्स फ़ाइल में संग्रहीत है। जब हम अपने आप ही सूचकांक का उपयोग करते हैं, तो QDoc, आधार URL के रूप में तब उपयोग करेगा जब सूचकांक में सूचीबद्ध कक्षाओं, फ़ंक्शंस, और अन्य चीज़ों के लिंक का निर्माण करेगा।

project     = Qt
description = Qt Reference Documentation
url         = http://doc.qt.io/qt-4.8/

     ...

यह सुनिश्चित करता है कि जब भी qt.index का उपयोग Qt वर्गों के उदाहरण के लिए संदर्भ उत्पन्न करने के लिए किया जाता है, आधार URL http://doc.qt.io/qt-4.8/

indexes भी देखें।

व्युत्पन्न परियोजनाओं का समर्थन कैसे करें

जब यह Qt संदर्भ दस्तावेज़ बनाता है तो यह सुविधा QDoc द्वारा उत्पन्न व्यापक अनुक्रमित का उपयोग करती है।

उदाहरण के लिए, qtgui.qdocconf (Qt के लिए कॉन्फ़िगरेशन फ़ाइल) में निम्नलिखित चर परिभाषाएँ हैं:

project     = Qt
description = Qt Reference Documentation
url         = http://doc.qt.io/qt-4.8/

...

project चर नाम का उपयोग इंडेक्स फ़ाइल के लिए फ़ाइल नाम बनाने के लिए किया जाता है; इस स्थिति में qt.index फ़ाइल बनाई जाती है। url को इंडेक्स फ़ाइल में संग्रहीत किया जाता है। बाद में, QDoc इसका उपयोग आधार URL के रूप में करेगा, जब यह कक्षाओं, फ़ंक्शंस और इंडेक्स में सूचीबद्ध अन्य चीजों के लिंक का निर्माण करेगा।