Qt 5.11

Status




qt

Status

ये आदेश यह दर्शाने के लिए हैं कि एक प्रलेखित तत्व की कुछ विशेष स्थिति है। तत्व को अप्रचलित किए जाने के रूप में चिह्नित किया जा सकता है, या यह कि इसे पहले के संस्करण के साथ संगतता के लिए प्रदान किया गया है, या बस सार्वजनिक इंटरफ़ेस में शामिल नहीं किया जाना है। कमांड के \since _ वर्जन संख्या को निर्दिष्ट करने के लिए जिसमें कोई फ़ंक्शन या क्लास पहली बार दिखाई दिया। \qmlabstract कमांड एक क्यूएमएल प्रकार को एक सार आधार वर्ग के रूप में चिह्नित करने के लिए है।

\ सार और \ qmlabstract

\ सार \ qmlabstract कमांड का एक पर्याय है। इस कमांड को एक QML प्रकार के लिए \qmltype टिप्पणी में जोड़ें जब उस प्रकार का उपयोग केवल सार आधार प्रकार के रूप में किया जाता है। जब कोई QML प्रकार सार है, तो इसका मतलब है कि QML प्रकार जो तुरंत नहीं किया जा सकता है। इसके बजाय, इसके सार्वजनिक एपीआई के गुणों को प्रत्येक क्यूएमएल प्रकार के लिए संदर्भ पृष्ठ पर सार्वजनिक गुण सूची में शामिल किया गया है जो सार एमएमएल प्रकार को विरासत में मिला है। संपत्तियों को इस तरह से प्रलेखित किया जाता है जैसे कि वे विरासत में मिली QML प्रकार की संपत्ति हैं।

आम तौर पर, जब QML प्रकार को \ qmlabstract के साथ चिह्नित किया जाता है , तो इसे \ आंतरिक के साथ भी चिह्नित किया जाता है ताकि इसका संदर्भ पृष्ठ उत्पन्न न हो। यह सार QML प्रकार आंतरिक चिह्नित नहीं है, यह प्रलेखन में एक संदर्भ पृष्ठ होगा।

\ compat

\\ कमांड आदेश यह इंगित करने के लिए है कि एक वर्ग या फ़ंक्शन पुराने स्रोत कोड को काम करने के लिए प्रदान की गई समर्थन लाइब्रेरी का हिस्सा है।

कमांड को अपनी लाइन पर खड़ा होना चाहिए।

आमतौर पर एक समकक्ष फ़ंक्शन या क्लास को विकल्प के रूप में प्रदान किया जाता है।

यदि आदेश का उपयोग किसी वर्ग के दस्तावेज़ीकरण में किया जाता है, तो कमांड एक चेतावनी का विस्तार करता है कि संदर्भित वर्ग समर्थन पुस्तकालय का हिस्सा है। चेतावनी प्रलेखन पृष्ठ के शीर्ष पर स्थित है।

\beginqdoc
    \class MyQt3SupportClass
    \compat
\endqdoc

QDoc इसे MyQt3SupportClass वर्ग संदर्भ पृष्ठ के शीर्ष पर प्रस्तुत करता है।

यह क्लास Qt 3 सपोर्ट लाइब्रेरी का हिस्सा है। यह पुराने स्रोत कोड को काम करने के लिए प्रदान किया जाता है। हम दृढ़ता से नए कोड में इसके उपयोग के खिलाफ सलाह देते हैं। अधिक जानकारी के लिए पोर्टिंग गाइड देखें।

यदि किसी फंक्शन को डॉक्यूमेंट करते समय कमांड का उपयोग किया जाता है, तो QDoc संबंधित क्लास के लिए रेफरेंस डॉक्यूमेंटेशन जनरेट करते समय Qt 3 सपोर्ट सदस्यों को डॉक्यूमेंट करते हुए एक अलग पेज बनाएगा और लिंक करेगा।

\beginqdoc
    \fn MyClass::MyQt3SupportMemberFunction
    \compat

    Use MyNewFunction() instead.
\endqdoc

QDoc इसे myclass-qt3.html में myclass-qt3.html करता है:

Qt 3 MyClass के लिए समर्थन सदस्य

निम्न वर्ग के सदस्य Qt 3 समर्थन परत का हिस्सा हैं। उन्हें Qt 4 में पुराने कोड को पोर्ट करने में आपकी सहायता करने के लिए प्रदान किया जाता है। हम उन्हें नए कोड में उपयोग करने के खिलाफ सलाह देते हैं।

...

  • शून्य MyQt3SupportMemberFunction ()
  • ...

सदस्य समारोह प्रलेखन

शून्य MyQt3SupportMemberFunction ()

इसके बजाय MyNewFunction () का उपयोग करें।

...

\चूक

डिफ़ॉल्ट गुण के रूप में एक QML प्रॉपर्टी को चिह्नित करने के लिए \ default कमांड है। default शब्द संपत्ति के प्रलेखन में प्रदर्शित किया जाता है।

/ *!
    \qmlproperty list<Change> State::changes
    This property holds the changes to apply for this state.
    \default

    By default these changes are applied against the default state. If the state
    extends another state, then the changes are applied against the state being
    extended.
* /

देखें कि QDoc State टाइप के संदर्भ पृष्ठ पर इस गुण को कैसे प्रस्तुत करता है।

\ अप्रचलित

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

कमांड को अपनी लाइन पर खड़ा होना चाहिए।

जब एक वर्ग के लिए संदर्भ दस्तावेज तैयार करते हैं, तो QDoc अपने अप्रचलित कार्यों का दस्तावेजीकरण करते हुए एक अलग पेज बनाएगा और लिंक करेगा। आमतौर पर एक समकक्ष फ़ंक्शन एक विकल्प के रूप में प्रदान किया जाता है।

/ *!
    \fn MyClass::MyObsoleteFunction
    \obsolete

    Use MyNewFunction() instead.
* /

QDoc ने इसे myclass- myclass-obsolete.html html में प्रस्तुत किया है:

MyClass के लिए अप्रचलित सदस्य

निम्न वर्ग के सदस्य अप्रचलित हैं। उन्हें पुराने स्रोत कोड को काम करने के लिए प्रदान किया जाता है। हम उन्हें नए कोड में उपयोग करने के खिलाफ दृढ़ता से सलाह देते हैं।

...

  • शून्य MyObirectFunction () (obsolete)
  • ...

सदस्य समारोह प्रलेखन

शून्य MyObirectFunction ()

इसके बजाय MyNewFunction () का उपयोग करें।

...

\अंदर का

\ आंतरिक कमांड इंगित करता है कि संदर्भित फ़ंक्शन सार्वजनिक इंटरफ़ेस का हिस्सा नहीं है।

कमांड को अपनी लाइन पर खड़ा होना चाहिए।

QDoc संबंधित वर्ग संदर्भ प्रलेखन उत्पन्न करते समय प्रलेखन के साथ-साथ प्रलेखित आइटम की भी अनदेखी करता है।

/ *!
    \internal

    Tries to find the decimal separator. If it can't find
    it and the thousand delimiter is != '.' it will try to
    find a '.';
* /
int QDoubleSpinBoxPrivate::findDelimiter
        (const QString &str, int index) const
{
    int dotindex = str.indexOf(delimiter, index);
    if (dotindex == -1 && thousand != dot && delimiter != dot)
        dotindex = str.indexOf(dot, index);
    return dotindex;
}

इस फ़ंक्शन को प्रलेखन में शामिल नहीं किया जाएगा।

\ प्रारंभिक

\ प्रारंभिक आदेश यह इंगित करने के लिए है कि एक संदर्भित फ़ंक्शन अभी भी विकास के अधीन है।

कमांड को अपनी लाइन पर खड़ा होना चाहिए।

\ Preliminary कमांड फंक्शन डॉक्यूमेंटेशन में एक नोटिफिकेशन में फैलती है, और यह लिस्ट में दिखाई देने पर फंक्शन को प्रारंभिक के रूप में चिह्नित करता है।

/ *!
    \preliminary

    Returns information about the joining type attributes of the
    character (needed for certain languages such as Arabic or
    Syriac).

* /
QChar::JoiningType QChar::joiningType() const
{
    return QChar::joiningType(ucs);
}

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

JoiningType QChar :: joinType () const

यह कार्य विकास और परिवर्तन के अधीन है।

चरित्र के जुड़ने के प्रकार के बारे में जानकारी देता है (कुछ भाषाओं के लिए आवश्यक है जैसे कि अरबी या सिरिएक)।

और सार्वजनिक कार्यों की QChar की सूची में समारोह की प्रविष्टि इस प्रकार प्रस्तुत की जाएगी:

\जबसे

\ _ कमांड के बाद से संबंधित कार्यशीलता को किस मामूली से जोड़ा गया है।

/ *!
    \since 4.1

    Returns an icon for \a standardIcon.

    ...

    \sa standardPixmap()
* /
QIcon QStyle::standardIcon(StandardPixmap standardIcon, const QStyleOption *option, const QWidget *widget) const
{
}

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

QIcon QStyle :: standardIcon (StandardPixmap standardIcon, const QStyleOption * विकल्प, const QWidget * विजेट) const

यह फ़ंक्शन Qt संस्करण 4.1 में पेश किया गया था

StandardIcon के लिए एक आइकन देता है।

...

StandardPixmap standardPixmap() भी देखें।

QDoc project कॉन्फ़िगरेशन चर से "Qt" संदर्भ उत्पन्न करता है। उस कारण से यह संदर्भ वर्तमान प्रलेखन परियोजना के अनुसार बदल जाएगा।

project भी देखें