Qt 5.11 - Relating Things

चीजों से संबंधित




qt

चीजों से संबंधित

संबंधित आदेश यह निर्दिष्ट करने के लिए हैं कि कैसे एक प्रलेखित तत्व दूसरे प्रलेखित तत्व से संबंधित है। कुछ उदाहरण:

  • यह फ़ंक्शन किसी अन्य फ़ंक्शन का अधिभार है।
  • यह फ़ंक्शन किसी अन्य फ़ंक्शन का पुन: कार्यान्वयन है।
  • यह टाइपफ़ेफ़ कुछ वर्ग या हेडर फ़ाइल से संबंधित है।

दस्तावेज करने के लिए एक आदेश यह भी है कि एक QML प्रकार कुछ अन्य QML प्रकार को विरासत में मिला।

आदेश

\ inherits

\ वारिस कमांड आदेश के लिए है कि एक QML प्रकार कुछ अन्य QML प्रकार विरासत में मिला है। इसे \qmltype एलिमेंट की \qmltype टिप्पणी में शामिल किया जाना चाहिए। तर्क विरासत में मिली QML प्रकार का नाम है।

/ *!
    \qmltype PauseAnimation
    \instantiates QDeclarativePauseAnimation
    \ingroup qml-animation-transition
    \since 4.7
    \inherits Animation
    \brief The PauseAnimation element provides a pause for an animation.

    When used in a SequentialAnimation, PauseAnimation is a step
    when nothing happens, for a specified duration.

    A 500ms animation sequence, with a 100ms pause between two animations:

    SequentialAnimation {
        NumberAnimation { ... duration: 200 }
        PauseAnimation { duration: 100 }
        NumberAnimation { ... duration: 200 }
    }

    \sa {QML Animation and Transitions}, {declarative/animation/basics}{Animation basics example}
* /

QDoc में PauseAnimation तत्व के संदर्भ पृष्ठ पर यह रेखा शामिल है:

इनहेरिट्स Animation

\ अधिभार

एक कार्यभार यह इंगित करने के लिए है कि कोई फ़ंक्शन उसके नाम का द्वितीयक अधिभार है।

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

एक फ़ंक्शन नाम के लिए जो अतिभारित होता है (निर्माणकर्ताओं को छोड़कर), QDoc फ़ंक्शन के एक प्राथमिक संस्करण की अपेक्षा करता है, और सभी अन्य अधिभार कमांड के साथ चिह्नित होते हैं। प्राथमिक संस्करण को पूरी तरह से प्रलेखित किया जाना चाहिए। प्रत्येक अधिभार में जो भी अतिरिक्त प्रलेखन हो सकता है, आप उस अतिभारित संस्करण के लिए जोड़ना चाहते हैं।

क्यूटी ४.५ से, आप फ़ंक्शन नाम प्लस () को एक पैरामीटर के रूप में \ _ अधिभार कमांड में शामिल कर सकते हैं, जिसमें एक मानक शामिल होगा यह फ़ंक्शन ओवरलोड ... पाठ के लाइन के साथ प्राइमरी संस्करण के दस्तावेज के लिंक के साथ समारोह।

/ *!
    \overload addAction()

    This convenience function creates a new action with an
    \a icon and some \a text. The function adds the newly
    created action to the menu's list of actions, and
    returns it.

    \sa QWidget::addAction()
* /
QAction *QMenu::addAction(const QIcon &icon, const QString &text)
{
    QAction *ret = new QAction(icon, text, this);
    addAction(ret);
    return ret;
}

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

QAction * QMenu :: addAction (const QIcon & icon , const QString & text )

यह फ़ंक्शन अधिभार को addAction()

यह सुविधा फ़ंक्शन आइकन और कुछ पाठ के साथ एक नई क्रिया बनाता है। फ़ंक्शन मेनू के कार्यों की सूची में नई बनाई गई कार्रवाई को जोड़ता है, और इसे वापस करता है।

यह भी देखें QWidget::addAction ()।

यदि आप फ़ंक्शन नाम को ओवरलोड कमांड के साथ शामिल नहीं करते हैं, तो "यह फ़ंक्शन ओवरलोड ..." के बजाय प्राथमिक संस्करण के लिए दस्तावेज़ के लिंक के साथ है, आपको पुरानी मानक लाइन मिलती है:

यह एक ओवरलोडेड सदस्य फ़ंक्शन है जो सुविधा के लिए उपलब्ध कराया गया है।

\ reimp

\ Reimp कमांड यह इंगित करने के लिए है कि एक फ़ंक्शन वर्चुअल फ़ंक्शन का पुन: कार्यान्वयन है।

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

QDoc वर्ग के संदर्भ से कार्यान्वित फ़ंक्शन को छोड़ देगा।

/ *!
    \reimp
* /
void QToolButton::nextCheckState()
{
    Q_D(QToolButton);
    if (!d->defaultAction)
        QAbstractButton::nextCheckState();
    else
        d->defaultAction->trigger();
}

इस फ़ंक्शन को प्रलेखन में शामिल नहीं किया जाएगा। इसके बजाय, आधार फ़ंक्शन QAbstractButton::nextCheckState () का एक लिंक प्रलेखन में दिखाई देगा।

\ संबंधित है

\ Relates कमांड कुछ क्लास या हेडर फ़ाइल के लिए एक वैश्विक तत्व के प्रलेखन को शामिल करने के लिए है। तर्क एक वर्ग नाम या हेडर फ़ाइल है।

/ *!
    \relates QChar

    Reads a char from the stream \a in into char \a chr.

    \sa {Format of the QDataStream operators}
* /
QDataStream &operator>>(QDataStream &in, QChar &chr)
{
    quint16 u;
    in >> u;
    chr.unicode() = ushort(u);
    return in;
}

इस फ़ंक्शन के लिए प्रलेखन को क्लास QChar के संदर्भ पृष्ठ पर शामिल किया जाएगा।