Qt 5.11

Miscellaneous




qt

Miscellaneous

ये आदेश दस्तावेज़ीकरण के दृश्य स्वरूप से जुड़े, और दस्तावेज़ बनाने की प्रक्रिया से जुड़े विविध कार्य प्रदान करते हैं।

\ annotatedlist

\ Annotatedlist कमांड एक समूह के सदस्यों की सूची में फैलता है, प्रत्येक सदस्य अपने संक्षिप्त पाठ के साथ सूचीबद्ध होता है। नीचे Qt संदर्भ दस्तावेज से एक उदाहरण दिया गया है:

/ *!
    ...
    \section1 Drag and Drop Classes

    These classes deal with drag and drop and the necessary mime type
    encoding and decoding.

    \annotatedlist draganddrop

* /

यह ड्रैगड्रॉप समूह में सभी C ++ वर्गों और / या QML प्रकारों की एक सूची बनाता है। ड्रैगड्रॉप समूह में एक C ++ वर्ग या QML प्रकार के पास अपने \ वर्ग या \ qmlype प्रकार की टिप्पणी में \ ingroup draganddrop होगा।

\ generatelist

\ Genatelist कमांड एक समूह में प्रलेखन संस्थाओं के लिंक की एक सूची में फैलता है। नीचे Qt संदर्भ दस्तावेज से एक उदाहरण दिया गया है:

/ *!
    \page classes.html
    \title All Classes

    For a shorter list that only includes the most
    frequently used classes, see \l{Qt's Main Classes}.

    \generatelist classes Q
* /

यह ऑल क्लास पेज बनाता है। आदेश निम्नलिखित तर्कों को स्वीकार करता है:

annotatedclasses

annotatedclasses तर्क एक तालिका प्रदान करता है जिसमें सभी वर्गों के नाम और प्रत्येक वर्ग का विवरण होता है। प्रत्येक वर्ग का नाम कक्षा के संदर्भ प्रलेखन का एक लिंक है। उदाहरण के लिए:

QDial गोल सीमा नियंत्रण (जैसे स्पीडोमीटर या पोटेंशियोमीटर)
QDialog संवाद खिड़कियों का आधार वर्ग
QDir निर्देशिका संरचनाओं और उनकी सामग्री तक पहुंच

C ++ क्लास को \class कमांड के साथ प्रलेखित किया जाता है। वर्ग के लिए एनोटेशन वर्ग टिप्पणी के \brief आदेश के तर्क से लिया जाता है।

annotatedexamples

annotatedexamples तर्क सभी उदाहरणों के शीर्षक वाले तालिकाओं के एक सेट के रूप में सभी उदाहरणों की एक पूरी सूची प्रदान करता है, और प्रत्येक उदाहरण का विवरण। प्रत्येक शीर्षक उदाहरण के प्रलेखन का एक लिंक है।

प्रत्येक मॉड्यूल के लिए एक अलग तालिका (जिसने उदाहरणों को प्रलेखित किया है) उत्पन्न होती है, बशर्ते कि मॉड्यूल ने एक नेविगेशन .landingpage कॉन्फ़िगरेशन चर को परिभाषित किया हो। लैंडिंग पृष्ठ चर का उपयोग शीर्ष लेख के लिए एक शीर्षक के रूप में किया जाता है जो प्रत्येक तालिका से पहले होता है।

annotatedattributions

annotatedattributions तर्क सभी एट्रिब्यूशन के शीर्षक वाले तालिकाओं के एक सेट के रूप में सभी एट्रिब्यूशन की पूरी सूची प्रदान करता है, और प्रत्येक एट्रिब्यूशन का विवरण। प्रत्येक शीर्षक एट्रिब्यूशन पेज का लिंक है।

प्रत्येक मॉड्यूल के लिए एक अलग तालिका (जिसमें एट्रिब्यूशन है) उत्पन्न होती है, बशर्ते कि मॉड्यूल ने एक नेविगेशन.लैंडिंगपेज कॉन्फ़िगरेशन चर को परिभाषित किया हो। लैंडिंग पृष्ठ चर का उपयोग शीर्ष लेख के लिए एक शीर्षक के रूप में किया जाता है जो प्रत्येक तालिका से पहले होता है।

classes <prefix>

classes तर्क classes एक पूरी वर्णमाला सूची प्रदान करता है। दूसरा तर्क, <prefix> , वर्ग नामों के लिए सामान्य उपसर्ग है। वर्ग नामों को सामान्य उपसर्ग का अनुसरण करने वाले वर्ण पर क्रमबद्ध किया जाएगा। उदाहरण के लिए क्यूटी वर्गों के लिए सामान्य उपसर्ग Q । सामान्य उपसर्ग तर्क वैकल्पिक है। यदि कोई सामान्य उपसर्ग प्रदान नहीं किया जाता है, तो वर्ग के नाम उनके पहले वर्ण पर छाँटे जाएंगे।

प्रत्येक वर्ग का नाम कक्षा के संदर्भ प्रलेखन का एक लिंक बन जाता है। इस आदेश का उपयोग सभी वर्गों के पेज को इस तरह से बनाने के लिए किया जाता है:

/ *!
    \page classes.html
    \title All Classes
    \ingroup classlists

    \brief Alphabetical list of classes.

    This is a list of all Qt classes. For a list of the classes
    provided for compatibility with Qt3, see \l{Qt3 Support
    Classes}. For classes that have been deprecated, see the
    \l{Obsolete Classes} list.

    \generatelist classes Q
* /

C ++ क्लास को \class कमांड के साथ प्रलेखित किया जाता है।

classesbymodule

जब इस तर्क का उपयोग किया जाता है, तो एक दूसरे तर्क की आवश्यकता होती है, जो उस मॉड्यूल को निर्दिष्ट करता है जिसकी कक्षाएं सूचीबद्ध की जानी हैं। QDoc उन वर्गों से युक्त एक तालिका बनाता है। प्रत्येक वर्ग को उसके \brief आदेश के पाठ के साथ सूचीबद्ध किया गया है।

उदाहरण के लिए, इस कमांड का उपयोग मॉड्यूल पेज पर निम्नानुसार किया जा सकता है:

/ *!
    \page phonon-module.html
    \module Phonon
    \title Phonon Module
    \ingroup modules

    \brief Contains namespaces and classes for multimedia functionality.

    \generatelist{classesbymodule Phonon}

...

* /

प्रत्येक वर्ग जो निर्दिष्ट मॉड्यूल का सदस्य है, को उसके \inmodule टिप्पणी में \inmodule कमांड के साथ चिह्नित किया जाना चाहिए।

qmltypesbymodule

classesbymodule तर्क के समान, लेकिन दूसरे तर्क के साथ निर्दिष्ट QML मॉड्यूल से QML प्रकारों को सूचीबद्ध करने के लिए उपयोग किया जाता है।

नोट: इस तर्क के लिए समर्थन QDoc 5.6 में पेश किया गया था।

jstypesbymodule

classesbymodule तर्क के समान, लेकिन दूसरे तर्क के साथ निर्दिष्ट मॉड्यूल से जावास्क्रिप्ट प्रकारों को सूचीबद्ध करने के लिए उपयोग किया जाता है।

नोट: इस तर्क के लिए समर्थन QDoc 5.6 में पेश किया गया था।

compatclasses

compatclasses तर्क समर्थन वर्गों के वर्णमाला क्रम में एक सूची बनाता है। यह आम तौर पर केवल Qt3 सहायता वर्ग पृष्ठ को इस तरह से बनाने के लिए उपयोग किया जाता है:

/ *!
    \page compatclasses.html
    \title Qt3 Support Classes
    \ingroup classlists

    \brief Enable porting of code from Qt 3 to Qt 4.

    These are the classes that Qt provides for compatibility with Qt
    3. Most of these are provided by the Qt3Support module.

    \generatelist compatclasses
* /

एक सहायक वर्ग की पहचान \compat कमेंट में the \compat कमांड के साथ की जाती है।

examplefiles [regular_expression]

examplefiles तर्क उन फ़ाइलों को सूचीबद्ध करता है जो एक उदाहरण परियोजना का हिस्सा हैं। वैकल्पिक दूसरा तर्क एक नियमित अभिव्यक्ति है; यदि प्रदान किया जाता है, तो केवल वे फाइलें जिनकी पथ नियमित अभिव्यक्ति के साथ मेल खाती है, सूचीबद्ध हैं।

examplefiles तर्क का उपयोग केवल उदाहरण के दस्तावेज़ ( \example देखें) के भीतर किया जा सकता है, और आमतौर पर \noautolist कमांड के साथ एक साथ उपयोग किया जाता है।

exampleimages [regular_expression]

उदाहरण तर्क उन छवियों को सूचीबद्ध करता है जो एक उदाहरण परियोजना का हिस्सा हैं। वैकल्पिक दूसरा तर्क एक नियमित अभिव्यक्ति है; यदि प्रदान किया गया है, तो केवल छवि फाइलें जिनका पथ नियमित अभिव्यक्ति के साथ मेल खाता है, सूचीबद्ध हैं।

उदाहरण का तर्क केवल उदाहरण के दस्तावेज़ ( \example देखें) के भीतर उपयोग किया जा सकता है, और आमतौर पर \noautolist कमांड के साथ एक साथ उपयोग किया जाता है।

functionindex

functionindex तर्क सभी दस्तावेज सदस्य कार्यों की एक पूरी वर्णमाला सूची प्रदान करता है। यह आमतौर पर केवल Qt फ़ंक्शन इंडेक्स पेज को इस तरह से जनरेट करने के लिए उपयोग किया जाता है:

/ *!
    \page functions.html
    \title All Functions
    \ingroup funclists

    \brief All documented Qt functions listed alphabetically with a
    link to where each one is declared.

    This is the list of all documented member functions and global
    functions in the Qt API. Each function has a link to the
    class or header file where it is declared and documented.

    \generatelist functionindex
* /

legalese

legalese दस्तावेज QDoc को वर्तमान प्रलेखन परियोजना में लाइसेंस की एक सूची बनाने के लिए कहता है। प्रत्येक लाइसेंस को \legalese आदेश का उपयोग करके पहचाना जाता है।

overviews

ओवरड्यू तर्क का उपयोग QDoc को सभी \group पेजों की सामग्री को संक्षिप्त करके एक सूची बनाने के लिए किया जाता है। Qt इस तरह से ओवरव्यू पेज बनाने के लिए इसका उपयोग करता है:

/ *!
    \page overviews.html

    \title All Overviews and HOWTOs

    \generatelist overviews
* /

attributions

डॉक्युमेंट्स में एट्रिब्यूशन की लिस्ट जेनरेट करने के लिए QDoc को बताने के लिए attributions तर्क का उपयोग किया जाता है।

related

related तर्क का उपयोग किसी निर्दिष्ट समूह से संबंधित सभी \ingroup को सूचीबद्ध करने के लिए \group और \ingroup आदेशों के संयोजन में किया जाता है। उदाहरण के लिए, Qt पृष्ठ के साथ प्रोग्रामिंग के लिए पृष्ठ इस तरह से उत्पन्न होता है:

/ *!
    \group qt-basic-concepts
    \title Programming with Qt

    \brief The basic architecture of the Qt cross-platform application and UI framework.

    Qt is a cross-platform application and UI framework for
    writing web-enabled applications for desktop, mobile, and
    embedded operating systems. This page contains links to
    articles and overviews explaining key components and
    techniuqes used in Qt development.

    \generatelist {related}
* /

इस समूह पृष्ठ पर सूचीबद्ध प्रत्येक पृष्ठ में कमांड शामिल है:

\ingroup qt-basic-concepts

\अगर

\ _ यदि कमांड और संबंधित \ एंडिफ कमांड एक क्यूडॉक टिप्पणी के कुछ हिस्सों को संलग्न करता है जो केवल तभी शामिल होगा जब कमांड के तर्क द्वारा निर्दिष्ट शर्त सत्य है।

कमांड शेष पंक्ति को पढ़ता है और इसे C ++ #if कथन के रूप में पार्स करता है।

/ *!
    \if defined(opensourceedition)

    \note This edition is for the development of
    \l{Qt Open Source Edition} {Free and Open Source}
    software only; see \l{Qt Commercial Editions}.

    \endif
* /

यह QDoc टिप्पणी केवल तभी प्रदान की जाएगी जब खुलने वाला पूर्वप्रक्रम चिह्न को परिभाषित किया गया हो, और QDoc प्रक्रिया को #ifdef और #endif के भीतर कोड बनाने के लिए कॉन्फ़िगरेशन फ़ाइल में defines चर में निर्दिष्ट किया गया हो:

defines = opensourceedition

आप कमांड लाइन पर मैन्युअल रूप से प्रीप्रोसेसर प्रतीक को भी परिभाषित कर सकते हैं। अधिक जानकारी के लिए defines चर का प्रलेखन देखें।

यह भी देखें कि \endif , \endif , defines और falsehoods

\अगर अंत

\ N एंडीफ कमांड और संबंधित \ _ यदि कमांड QDoc टिप्पणी के कुछ हिस्सों को सम्मिलित करता है जो \if कमांड के तर्क के सही होने पर निर्दिष्ट की गई शर्त को शामिल किया जाएगा।

अधिक जानकारी के लिए, \if कमांड का प्रलेखन देखें।

यह भी देखें \if \else , \else , defines और falsehoods

\अन्य

\if आदेश गलत है, \if कमांड एक विकल्प को निर्दिष्ट करता है।

\ अन्य कमांड केवल \if कमांड के भीतर उपयोग किया जा सकता है, लेकिन उपयोगी है जब केवल दो विकल्प हैं।

/ *!
    The Qt 3 support library is provided to keep old
    source code working.

    In addition to the \c Qt3Support classes, Qt 4 provides
    compatibility functions when it's possible for an old
    API to cohabit with the new one.

    \if !defined(QT3_SUPPORT)
        \if defined(QT3_SUPPORTWARNINGS)
            The compiler emits a warning when a
            compatibility function is called. (This works
            only with GCC 3.2+ and MSVC 7.)
        \else
            To use the Qt 3 support library, you need to
            have the line QT += qt3support in your .pro
            file (qmake automatically define the
            QT3_SUPPORT symbol, turning on compatibility
            function support).

            You can also define the symbol manually (for example,
            if you don't want to link against the \c
            Qt3Support library), or you can define \c
            QT3_SUPPORT_WARNINGS instead, telling the
            compiler to emit a warning when a compatibility
            function is called. (This works only with GCC
            3.2+ and MSVC 7.)
        \endif
    \endif
* /

यदि QT3_SUPPORT को परिभाषित किया जाता है, तो टिप्पणी इस तरह प्रदान की जाएगी:

पुराने सोर्स कोड को काम करने के लिए Qt 3 सपोर्ट लाइब्रेरी प्रदान की जाती है।

Qt3Support वर्गों के अलावा, Qt 4 जब पुराने API के लिए नए के साथ सहवास करना संभव होता है, तो अनुकूलता प्रदान करता है।

अगर QT3_SUPPORT को परिभाषित नहीं किया गया है, लेकिन QT3_SUPPORT_WARNINGS को परिभाषित किया गया है, तो टिप्पणी इस प्रकार होगी:

पुराने सोर्स कोड को काम करने के लिए Qt 3 सपोर्ट लाइब्रेरी प्रदान की जाती है।

Qt3Support वर्गों के अलावा, Qt 4 जब पुराने API के लिए नए के साथ सहवास करना संभव होता है, तो अनुकूलता प्रदान करता है।

कंपाइलर एक चेतावनी का उत्सर्जन करता है जब एक संगतता फ़ंक्शन कहा जाता है। (यह केवल GCC 3.2+ और MSVC 7. के साथ काम करता है)

यदि प्रतीकों में से कोई भी परिभाषित नहीं किया गया है, तो टिप्पणी को इस रूप में प्रस्तुत किया जाएगा

पुराने सोर्स कोड को काम करने के लिए Qt 3 सपोर्ट लाइब्रेरी प्रदान की जाती है।

Qt3Support वर्गों के अलावा, Qt 4 जब पुराने API के लिए नए के साथ सहवास करना संभव होता है, तो अनुकूलता प्रदान करता है।

Qt 3 सपोर्ट लाइब्रेरी का उपयोग करने के लिए, आपके पास .pro फ़ाइल में qt + = qt3support लाइन होना आवश्यक है (qmake स्वचालित रूप से QT3_SUPPORT प्रतीक को परिभाषित करता है, संगतता फ़ंक्शन समर्थन को चालू करता है)।

आप प्रतीक को मैन्युअल रूप से भी परिभाषित कर सकते हैं (उदाहरण के लिए, यदि आप Qt3Support लाइब्रेरी के विरुद्ध लिंक नहीं करना चाहते हैं), या आप इसके बजाय QT3_SUPPORT_WARNINGS को परिभाषित कर सकते हैं, कम्पाइलर को चेतावनी देते हुए QT3_SUPPORT_WARNINGS कि जब कम्पैटिबिलिटी फंक्शन कहा जाता है। (यह केवल GCC 3.2+ और MSVC 7. के साथ काम करता है)

यह भी देखें \if \endif , defines और falsehoods

\शामिल

\ _ कमांड में QDoc इनपुट स्ट्रीम के लिए अपने पहले तर्क द्वारा निर्दिष्ट फ़ाइल के सभी या हिस्से को QDoc टिप्पणी स्निपेट के रूप में संसाधित किया जाता है।

जब कमांड या टेक्स्ट के कुछ स्निपेट को प्रलेखन में कई स्थानों पर उपयोग किया जाना है, तो कमांड उपयोगी है। आप दस्तावेज़ में स्निपेट सम्मिलित करना चाहते हैं, जहाँ भी \ n कमांड का उपयोग करें। शामिल करने के लिए स्निपेट वाली फ़ाइल को स्रोत के तहत स्थित होना चाहिए, जो कि sourcedirs QDoc कॉन्फ़िगरेशन चर में सूचीबद्ध है। यह या तो किसी भी स्रोत फ़ाइल को QDoc द्वारा पार्स किया जा सकता है (या यहां तक ​​कि एक ही जहाँ \ n कमांड का उपयोग किया जाता है), या कोई अन्य टेक्स्ट फ़ाइल। एक अलग फ़ाइल में स्निपेट को संग्रहीत करने के लिए जिसे QDoc द्वारा पार्स नहीं किया जाना है, एक फ़ाइल एक्सटेंशन का उपयोग करें जो सूत्रों में सूचीबद्ध नहीं है। उदाहरण के लिए, .qdocinc

कमांड में एक या दो तर्क हो सकते हैं। पहला तर्क हमेशा एक फ़ाइल नाम होता है। फ़ाइल की सामग्री को QDoc इनपुट होना चाहिए, दूसरे शब्दों में, QDoc कमांड और टेक्स्ट का एक क्रम, लेकिन QDoc टिप्पणी / *! को संलग्न किए बिना *! ... * / परिसीमन। यदि आप संपूर्ण नामित फ़ाइल को शामिल करना चाहते हैं, तो दूसरे तर्क का उपयोग न करें। यदि आप फ़ाइल का केवल भाग शामिल करना चाहते हैं, तो नीचे दो तर्क फ़ॉर्म देखें। यहाँ एक तर्क रूप का एक उदाहरण दिया गया है:

/ *!
    \page corefeatures.html
    \title Core Features

    \include examples/signalandslots.qdocinc
    \include examples/objectmodel.qdocinc
    \include examples/layoutmanagement.qdocinc
* /

QDoc इस पृष्ठ को यहां दिखाए गए अनुसार प्रस्तुत करता है

\ फ़ाइल नाम स्निपेट-पहचानकर्ता शामिल हैं

यह समय की बर्बादी है। प्रत्येक QDoc के लिए एक अलग .qdocinc फ़ाइल बनाने के लिए, स्निपेट को आप प्रलेखन में कई स्थानों पर उपयोग करना चाहते हैं, विशेष रूप से यह देखते हुए कि आपको संभवतः इनमें से हर एक फ़ाइल में कॉपीराइट / लाइसेंस नोटिस लगाना है। इसलिए यदि आपके पास बड़ी संख्या में स्निपेट शामिल हैं, तो आप उन सभी को एक सिंगल फाइल में रख सकते हैं, यदि आप चाहते हैं, और प्रत्येक को एक साथ घेर लें:

    //! [snippet-id1]

       QDoc commands and text...

//! [snippet-id1]

    //! [snippet-id2]

       More QDoc commands and text...

//! [snippet-id2]

तब आप कमांड के दो-तर्क रूप का उपयोग कर सकते हैं:

\input examples/signalandslots.qdocinc snippet-id2
\input examples/objectmodel.qdocinc another-snippet-id

यह उम्मीद के मुताबिक काम करता है। QDoc कमांड्स और टेक्स्ट को दो टैग्स के बीच एक ही नाम के साथ पाया जाता है क्योंकि दूसरा तर्क QDoc इनपुट स्ट्रीम में भेजा जाता है। आप घोंसले के शिकार स्निपेट भी कर सकते हैं।

नोट: स्निपेट पहचानकर्ता दस्तावेज़ीकरण टिप्पणी (/ *! .. * /) ब्लॉकों के भीतर भी काम करते हैं, इसलिए एक अलग .qdocinc फ़ाइल का उपयोग करना आवश्यक नहीं है। एक टिप्पणी ब्लॉक को संसाधित करते समय, QDoc किसी भी //! को हटा देता है //! उत्पन्न आउटपुट से टिप्पणी लाइनें।

\ मेटा

मुख्य रूप से DITA XML फ़ाइलों में मेटाडेटा को शामिल करने के लिए \ meta कमांड का उपयोग किया जाता है। इसका उपयोग मेटाडेटा को उदाहरण के प्रलेखन में जोड़ने के लिए भी किया जाता है, और जब C ++ वर्ग के अनुरक्षक (एस) को निर्दिष्ट करने के लिए HTML आउटपुट उत्पन्न करते हैं।

कमांड के दो तर्क हैं: पहला तर्क मेटाडेटा विशेषता का नाम है, और दूसरा तर्क विशेषता के लिए मूल्य है। प्रत्येक तर्क को घुंघराले ब्रैकेट में संलग्न किया जाना चाहिए, जैसा कि इस उदाहरण में दिखाया गया है:

/ *!
    \class QWidget
    \brief The QWidget class is the base class of all user interface objects.

    \ingroup basicwidgets

    \meta {technology} {User Interface}
    \meta {platform} {macOS 10.6}
    \meta {platform} {MeeGo}
    \meta {audience} {user}
    \meta {audience} {programmer}
    \meta {audience} {designer}
* /

HTML उत्पन्न करने के लिए QDoc चलाते समय, ऊपर दिए गए उदाहरण से उत्पन्न आउटपुट पर कोई प्रभाव नहीं पड़ेगा, लेकिन यदि आप DITA XML बनाने के लिए QDoc चलाते हैं, तो उदाहरण निम्नलिखित उत्पन्न करेगा:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cxxClass PUBLIC "-//NOKIA//DTD DITA C++ API Class Reference Type v0.6.0//EN" "dtd/cxxClass.dtd">
<!--qwidget.cpp-->
<cxxClass id="id-9a14268e-6b09-4eee-b940-21a00a0961df">
   <apiName>QWidget</apiName>
   <shortdesc>the QWidget class is the base class of all user interface objects.</shortdesc>
   <prolog>
       <author>Qt Development Frameworks</author>
       <publisher>Qt Project</publisher>
       <copyright>
           <copyryear year="2018"/>
           <copyrholder>Qt Project</copyrholder>
       </copyright>
       <permissions view="all"/>
       <metadata>
           <audience type="designer"/>
           <audience type="programmer"/>
           <audience type="user"/>
           <category>Class reference</category>
           <prodinfo>
               <prodname>Qt Reference Documentation</prodname>
               <vrmlist>
                   <vrm version="4" release="7" modification="3"/>
               </vrmlist>
               <component>QtGui</component>
           </prodinfo>
           <othermeta name="platform" content="MeeGo"/>
           <othermeta name="platform" content="macOS 10.6"/>
           <othermeta name="technology" content="User Interface"/>
       </metadata>
   </prolog>

उदाहरण आउटपुट में, QDoc कॉन्फ़िगरेशन फ़ाइल से प्राप्त डिफ़ॉल्ट मानों का उपयोग करके कई मान सेट किए गए हैं। विवरण के लिए जनरेटिंग DITA XML आउटपुट देखें।

उदाहरण मेटाडेटा

\ मेटा कमांड के लिए एक अन्य उपयोग मेटाडेटा (टैग) को \example प्रलेखन में शामिल करना है। डिफ़ॉल्ट रूप से, QDoc उदाहरण के \title और मॉड्यूल नाम के आधार पर उदाहरण टैग बनाता है। ये टैग Qt क्रिएटर के वेलकम मोड में प्रदर्शित होते हैं, जो उपयोगकर्ताओं को उदाहरणों की सूची को नेविगेट करने में मदद करते हैं।

अतिरिक्त टैग \\meta {tag} {tag1,[tag2,...]} के साथ बनाए जा सकते हैं। उदाहरण के लिए:

/ *!
    \example helloworld
    \title Hello World Example
    \meta {tag} {tutorial,basic}
* /

यह निम्नलिखित टैग में परिणाम देगा: ट्यूटोरियल, बुनियादी, नमस्ते, दुनिया उदाहरण जैसे सामान्य शब्दों को अनदेखा कर दिया जाता है।

\ noautolist

\ Noautolist कमांड इंगित करता है कि C ++ क्लासेस या QML प्रकारों की एनोटेट सूची, जो C ++ या QML मॉड्यूल पेज के नीचे स्वचालित रूप से उत्पन्न होती है, को छोड़ दिया जाना चाहिए, क्योंकि कक्षाएं या प्रकार मैन्युअल रूप से सूचीबद्ध किए गए हैं। इस आदेश का उपयोग समूह के सदस्यों की सूची को छोड़ने के लिए \group कमांड के साथ भी किया जा सकता है, जब वे मैन्युअल रूप से सूचीबद्ध होते हैं।

कमांड को अपनी लाइन पर खड़ा होना चाहिए। एक उदाहरण के लिए Qt सेंसर QML प्रकार देखें। पृष्ठ qtsensors5.qdoc से जनरेट किया qtsensors5.qdoc । वहाँ आपको QtSensors मॉड्यूल के लिए \qmlmodule कमांड युक्त एक qdoc टिप्पणी मिलेगी । समान qdoc टिप्पणी में दो अलग-अलग समूहों में QML प्रकारों को सूचीबद्ध करने के लिए दो \annotated-list कमांड होते हैं। क्यूएमएल प्रकार को इन दो समूहों में विभाजित किया गया है क्योंकि यह उन्हें इस तरह से सूचीबद्ध करने के लिए अधिक समझ में आता है, जैसा कि उन्हें एकल वर्णमाला सूची में सूचीबद्ध करने के लिए होता है। टिप्पणी के नीचे, \noautolist का उपयोग qdoc को स्वचालित एनोटेट सूची उत्पन्न करने के लिए नहीं बताने के लिए किया गया है।

इस कमांड को QDoc 5.6 में पेश किया गया था।

क्यूटी 5.10 के बाद से, यह कमांड \example _ \example प्रलेखन पर भी लागू किया जा सकता है, जहां यह एक उदाहरण परियोजना से संबंधित फाइलों और छवियों की स्वचालित रूप से उत्पन्न सूची को छोड़ने का कारण बनता है।

\ न आना

\ Omit कमांड और संबंधित \ endomit कमांड डॉक्यूमेंट के कुछ हिस्सों को सीमांकित करता है जिन्हें आप QDoc को छोड़ना चाहते हैं। उदाहरण के लिए:

/ *!
    \table
    \row
        \li Basic Widgets
        \li Basic GUI widgets such as buttons, comboboxes
           and scrollbars.

    \omit
    \row
        \li Component Model
        \li Interfaces and helper classes for the Qt
           Component Model.
    \endomit

    \row
        \li Database Classes
        \li Database related classes, e.g. for SQL databases.
    \endtable
* /

QDoc इसे प्रस्तुत करता है:

मूल विजेट बेसिक GUI विगेट्स जैसे बटन, कॉम्बोक्स और स्क्रॉलबार्स।
डेटाबेस क्लासेस डेटाबेस संबंधित कक्षाएं, जैसे SQL डेटाबेस के लिए।

कच्चे (से बचें)

\ कच्ची कमांड और संबंधित \ endraw कमांड कच्चे मार्क-अप भाषा कोड के एक ब्लॉक का परिसीमन करती है।

नोट: यदि संभव हो तो इस कमांड का उपयोग करने से बचें, क्योंकि यह DITA XML कोड बनाता है जो समस्याओं का कारण बनता है। यदि आप विशेष तालिका या सूची व्यवहार उत्पन्न करने की कोशिश कर रहे हैं, तो अपने \table या \list में \span और \div कमांड का उपयोग करके इच्छित व्यवहार प्राप्त करने का प्रयास करें।

आदेश कोड के प्रारूप को निर्दिष्ट करने वाला तर्क लेता है। वर्तमान में, एकमात्र समर्थित प्रारूप HTML है।

यदि आप अपने दस्तावेज़ में कुछ विशेष HTML प्रभाव चाहते हैं, तो \ raw कमांड उपयोगी है।

/ *!
    Qt has some predefined QColor objects.

    \raw HTML
    <style type="text/css" id="colorstyles">
    #color-blue { background-color: #0000ff; color: #ffffff }
    #color-darkBlue { background-color: #000080; color: #ffffff }
    #color-cyan { background-color: #00ffff; color: #000000 }
    </style>

    <p>
    <tt id="color-blue">Blue(#0000ff)</tt>,
    <tt id="color-darkBlue">dark blue(#000080)</tt> and
    <tt id="color-cyan">cyan(#00ffff)</tt>.
</p>
    \endraw
* /

QDoc इसे प्रस्तुत करता है:

Qt में कुछ पूर्वनिर्धारित QColor वस्तुएं हैं।

नीला (# 0000ff) , गहरा नीला (# 000080) और सियान (# 00ffff)

नोट: लेकिन आप qdoc कमांड का उपयोग करके सटीक एक ही चीज़ प्राप्त कर सकते हैं। इस मामले में, आपको केवल अपनी शैली में रंग शैलियों को शामिल करना होगा। फाइल फ़ाइल। तब आप लिख सकते हैं:

\tt {\span {id="color-blue"} {Blue(#0000ff)}},
\tt {\span {id="color-darkBlue"} {dark blue(#000080)}} and
\tt {\span {id="color-cyan"} {cyan(#00ffff)}}.

... जो इस प्रकार प्रस्तुत है:

Blue(#0000ff) , dark blue(#000080) और cyan(#00ffff)

\ यूनिकोड

\ Unicode कमांड आपको दस्तावेज़ में एक मनमाना यूनिकोड वर्ण सम्मिलित करने की अनुमति देता है।

कमांड एक तर्क लेता है जो वर्ण को पूर्णांक के रूप में निर्दिष्ट करता है। डिफ़ॉल्ट रूप से, आधार 10 को माना जाता है, जब तक कि '0x' या '0' उपसर्ग निर्दिष्ट नहीं किया जाता है (क्रमशः आधार 16 और 8 के लिए) उदाहरण के लिए:

O G\unicode{0xEA}nio e as Rosas

\unicode 0xC0 table en famille avec 15 \unicode 0x20AC par jour

\unicode 0x3A3 \e{a}\sub{\e{i}}

QDoc इसे प्रस्तुत करता है:

ओ गोसियो ई रोजस के रूप में

À टेबल एन फेमिल एवेसी 15 € par पत्रिकाओं

Σ