Qt 5.11 - The QDoc Configuration File

QDoc कॉन्फ़िगरेशन फ़ाइल




qt

QDoc कॉन्फ़िगरेशन फ़ाइल

QDoc चलाने से पहले, QDoc को बताने के लिए आपको QDoc कॉन्फ़िगरेशन फ़ाइल बनानी चाहिए, जहाँ QDoc टिप्पणियों वाले स्रोत फ़ाइलों को खोजने के लिए। आपकी कॉन्फ़िगरेशन फ़ाइल का पथ नाम QDoc को कमांड लाइन पर दिया गया है:

/current/dir$ ../../bin/qdoc ./config.qdocconf

सामान्य विवरण

कॉन्फ़िगरेशन फ़ाइल "चर = मान" फॉर्म की प्रविष्टियों की एक सूची है। कॉन्फ़िगरेशन चर का उपयोग करते हुए, आप यह परिभाषित कर सकते हैं कि QDoc को विभिन्न स्रोत फ़ाइलों, छवियों और उदाहरणों को कहां से प्राप्त करना चाहिए, जहां उत्पन्न प्रलेखन को रखना है आदि। कॉन्फ़िगरेशन फ़ाइल में निर्देश भी शामिल हो सकते include । एक उदाहरण के लिए, एक न्यूनतम qdocconf फ़ाइल देखें

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

कॉन्फ़िगरेशन चर का मान '=' या '+ =' का उपयोग करके सेट किया जा सकता है। अंतर यह है कि '=' पिछले मान को ओवरराइड करता है, जबकि '+ =' वर्तमान मान में एक नया मान जोड़ता है।

कुछ विन्यास चर अपने मूल्य के रूप में तार की एक सूची को स्वीकार करते हैं, उदाहरण के लिए: sourcedirs , जबकि अन्य केवल एक स्ट्रिंग को स्वीकार करते हैं। मूल्य स्ट्रिंग के आसपास के दोहरे उद्धरण वैकल्पिक हैं, लेकिन उनमें से आप मूल्य स्ट्रिंग के भीतर '=' और '"जैसे विशेष वर्णों का उपयोग करने की अनुमति देते हैं, उदाहरण के लिए:

HTML.postheader = "<a href=\"index.html\">Home</a>"

यदि कोई प्रविष्टि कई पंक्तियों को फैलाती है, तो हर पंक्ति के अंत में एक बैकस्लैश का उपयोग करें लेकिन अंतिम:

sourcedirs = kernel \
             tools \
             widgets

विन्यास चर

चर सूची

श्रेणियाँ

कॉन्फ़िगरेशन फ़ाइल उदाहरण

  • एक न्यूनतम कॉन्फ़िगरेशन फ़ाइल: न्यूनतम minimum.qdocconf
  • Qt कॉन्फ़िगरेशन फ़ाइल: qtgui.qdocconf