From 8c904712aa658dd0dd405b64913b8e6ade17f3df Mon Sep 17 00:00:00 2001 From: Martin Smith Date: Tue, 9 Mar 2010 12:04:59 +0100 Subject: doc: Fixed several qdoc errors. --- .../declarative/imageprovider/imageprovider.cpp | 1 + src/corelib/concurrent/qfuturewatcher.cpp | 2 +- src/corelib/global/qnamespace.qdoc | 2 +- src/corelib/tools/qeasingcurve.cpp | 4 ++-- src/corelib/tools/qstring.cpp | 22 +++++++++--------- .../graphicsitems/qdeclarativelistview.cpp | 5 ---- src/declarative/qml/qdeclarativeengine.cpp | 4 ++-- src/declarative/qml/qdeclarativeexpression.cpp | 27 +++++++++++----------- .../qml/qdeclarativeextensionplugin.cpp | 2 +- src/declarative/qml/qdeclarativeimageprovider.cpp | 4 ++++ src/declarative/qml/qdeclarativeproperty.cpp | 3 ++- src/declarative/util/qdeclarativeanimation.cpp | 8 ++++--- .../util/qdeclarativestateoperations.cpp | 3 --- src/gui/painting/qcolor.cpp | 11 ++------- src/gui/painting/qpainter.cpp | 8 +++---- src/gui/text/qstatictext.cpp | 6 +++-- src/multimedia/effects/qsoundeffect.cpp | 2 -- 17 files changed, 54 insertions(+), 60 deletions(-) diff --git a/examples/declarative/imageprovider/imageprovider.cpp b/examples/declarative/imageprovider/imageprovider.cpp index 253dbf5..011a63b 100644 --- a/examples/declarative/imageprovider/imageprovider.cpp +++ b/examples/declarative/imageprovider/imageprovider.cpp @@ -104,4 +104,5 @@ public: #include "imageprovider.moc" Q_EXPORT_PLUGIN(ImageProviderExtensionPlugin); +//![0] diff --git a/src/corelib/concurrent/qfuturewatcher.cpp b/src/corelib/concurrent/qfuturewatcher.cpp index 3b808b8..d4573c6 100644 --- a/src/corelib/concurrent/qfuturewatcher.cpp +++ b/src/corelib/concurrent/qfuturewatcher.cpp @@ -505,7 +505,7 @@ void QFutureWatcherBasePrivate::sendCallOutEvent(QFutureCallOutEvent *event) finished signal will be emitted. To avoid a race condition, it is important to call this function - \i after doing the connections. + \e after doing the connections. */ /*! \fn QFuture QFutureWatcher::future() const diff --git a/src/corelib/global/qnamespace.qdoc b/src/corelib/global/qnamespace.qdoc index 76541ca..f8f3c49 100644 --- a/src/corelib/global/qnamespace.qdoc +++ b/src/corelib/global/qnamespace.qdoc @@ -2990,7 +2990,7 @@ \value IgnoredGesturesPropagateToParent Since Qt 4.7, this flag allows you to fine-tune gesture event propagation. By setting the flag when - \l{QGraphicsObject::grabGesture}{grabbing} a gesture all ignored partial + \l{QGraphicsObject::grabGesture()}{grabbing} a gesture all ignored partial gestures will propagate to their parent items. \sa QWidget::grabGesture(), QGraphicsObject::grabGesture() diff --git a/src/corelib/tools/qeasingcurve.cpp b/src/corelib/tools/qeasingcurve.cpp index d4b2c27..9c65d5d 100644 --- a/src/corelib/tools/qeasingcurve.cpp +++ b/src/corelib/tools/qeasingcurve.cpp @@ -877,8 +877,8 @@ QDataStream &operator<<(QDataStream &stream, const QEasingCurve &easing) \fn QDataStream &operator>>(QDataStream &stream, QEasingCurve &easing) \relates QQuaternion - Reads an easing curve from the given \a stream into the given \a quaternion - and returns a reference to the stream. + Reads an easing curve from the given \a stream into the given \a + easing curve and returns a reference to the stream. \sa {Format of the QDataStream Operators} */ diff --git a/src/corelib/tools/qstring.cpp b/src/corelib/tools/qstring.cpp index 5ed3db5..b54315c 100644 --- a/src/corelib/tools/qstring.cpp +++ b/src/corelib/tools/qstring.cpp @@ -2135,7 +2135,7 @@ bool QString::operator==(const QLatin1String &other) const The \a other byte array is converted to a QString using the fromAscii() function. This function stops conversion at the - first NUL character found, or the end of the \a ba byte array. + first NUL character found, or the end of the byte array. You can disable this operator by defining \c QT_NO_CAST_FROM_ASCII when you compile your applications. This @@ -2197,7 +2197,7 @@ bool QString::operator<(const QLatin1String &other) const The \a other byte array is converted to a QString using the fromAscii() function. If any NUL characters ('\0') are embedded - in the \a ba byte array, they will be included in the transformation. + in the byte array, they will be included in the transformation. You can disable this operator by defining \c QT_NO_CAST_FROM_ASCII when you compile your applications. This @@ -2240,7 +2240,7 @@ bool QString::operator<(const QLatin1String &other) const The \a other byte array is converted to a QString using the fromAscii() function. If any NUL characters ('\0') are embedded - in the \a ba byte array, they will be included in the transformation. + in the byte array, they will be included in the transformation. You can disable this operator by defining \c QT_NO_CAST_FROM_ASCII when you compile your applications. This @@ -2299,7 +2299,7 @@ bool QString::operator>(const QLatin1String &other) const The \a other byte array is converted to a QString using the fromAscii() function. If any NUL characters ('\0') are embedded - in the \a ba byte array, they will be included in the transformation. + in the byte array, they will be included in the transformation. You can disable this operator by defining \c QT_NO_CAST_FROM_ASCII when you compile your applications. This @@ -2341,8 +2341,8 @@ bool QString::operator>(const QLatin1String &other) const \overload operator>=() The \a other byte array is converted to a QString using the - fromAscii() function. If any NUL characters ('\0') are embedded - in the \a ba byte array, they will be included in the transformation. + fromAscii() function. If any NUL characters ('\0') are embedded in + the byte array, they will be included in the transformation. You can disable this operator by defining \c QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want @@ -2357,10 +2357,10 @@ bool QString::operator>(const QLatin1String &other) const The \a other const char pointer is converted to a QString using the fromAscii() function. - You can disable this operator by defining \c - QT_NO_CAST_FROM_ASCII when you compile your applications. This - can be useful if you want to ensure that all user-visible strings - go through QObject::tr(), for example. + You can disable this operator by defining \c QT_NO_CAST_FROM_ASCII + when you compile your applications. This can be useful if you want + to ensure that all user-visible strings go through QObject::tr(), + for example. */ /*! \fn bool QString::operator!=(const QString &other) const @@ -2385,7 +2385,7 @@ bool QString::operator>(const QLatin1String &other) const The \a other byte array is converted to a QString using the fromAscii() function. If any NUL characters ('\0') are embedded - in the \a ba byte array, they will be included in the transformation. + in the byte array, they will be included in the transformation. You can disable this operator by defining \c QT_NO_CAST_FROM_ASCII when you compile your applications. This can be useful if you want diff --git a/src/declarative/graphicsitems/qdeclarativelistview.cpp b/src/declarative/graphicsitems/qdeclarativelistview.cpp index eaf90f2..d54bb70 100644 --- a/src/declarative/graphicsitems/qdeclarativelistview.cpp +++ b/src/declarative/graphicsitems/qdeclarativelistview.cpp @@ -1650,11 +1650,6 @@ void QDeclarativeListView::setPreferredHighlightEnd(qreal end) emit preferredHighlightEndChanged(); } -/*! - \property QDeclarativeListView::highlightRangeMode - - This property contains the highlight range mode for the listview. - */ QDeclarativeListView::HighlightRangeMode QDeclarativeListView::highlightRangeMode() const { Q_D(const QDeclarativeListView); diff --git a/src/declarative/qml/qdeclarativeengine.cpp b/src/declarative/qml/qdeclarativeengine.cpp index 9bff7b2..c23b17c 100644 --- a/src/declarative/qml/qdeclarativeengine.cpp +++ b/src/declarative/qml/qdeclarativeengine.cpp @@ -542,9 +542,9 @@ QNetworkAccessManager *QDeclarativeEngine::networkAccessManager() const This example creates a provider with id \e colors: - \snippet examples/declarative/imageprovider/main.cpp 0 + \snippet examples/declarative/imageprovider/imageprovider.cpp 0 - \snippet examples/declarative/imageprovider/view.qml 0 + \snippet examples/declarative/imageprovider/imageprovider.qml 0 \sa removeImageProvider() */ diff --git a/src/declarative/qml/qdeclarativeexpression.cpp b/src/declarative/qml/qdeclarativeexpression.cpp index e528e9e..899f402 100644 --- a/src/declarative/qml/qdeclarativeexpression.cpp +++ b/src/declarative/qml/qdeclarativeexpression.cpp @@ -512,19 +512,20 @@ bool QDeclarativeExpression::notifyOnValueChanged() const } /*! -Sets whether the valueChanged() signal is emitted when the expression's evaluated -value changes. - -If true, the QDeclarativeExpression will monitor properties involved in the expression's -evaluation, and emit QDeclarativeExpression::valueChanged() if they have changed. This allows -an application to ensure that any value associated with the result of the expression -remains up to date. - -If false, the QDeclarativeExpression will not montitor properties involved in the expression's -evaluation, and QDeclarativeExpression::valueChanged() will never be emitted. This is more efficient -if an application wants a "one off" evaluation of the expression. - -By default, notifyOnChange is false. + Sets whether the valueChanged() signal is emitted when the + expression's evaluated value changes. + + If \a notifyOnChange is true, the QDeclarativeExpression will + monitor properties involved in the expression's evaluation, and emit + QDeclarativeExpression::valueChanged() if they have changed. This + allows an application to ensure that any value associated with the + result of the expression remains up to date. + + If \a notifyOnChange is false (default), the QDeclarativeExpression + will not montitor properties involved in the expression's + evaluation, and QDeclarativeExpression::valueChanged() will never be + emitted. This is more efficient if an application wants a "one off" + evaluation of the expression. */ void QDeclarativeExpression::setNotifyOnValueChanged(bool notifyOnChange) { diff --git a/src/declarative/qml/qdeclarativeextensionplugin.cpp b/src/declarative/qml/qdeclarativeextensionplugin.cpp index 3d44d63..7617977 100644 --- a/src/declarative/qml/qdeclarativeextensionplugin.cpp +++ b/src/declarative/qml/qdeclarativeextensionplugin.cpp @@ -87,7 +87,7 @@ QDeclarativeExtensionPlugin::~QDeclarativeExtensionPlugin() /*! \fn void QDeclarativeExtensionPlugin::initializeEngine(QDeclarativeEngine *engine, const char *uri) - Initializes the extension specified in the given \a engine. + Initializes the extension from the \a uri using the \a engine. */ void QDeclarativeExtensionPlugin::initializeEngine(QDeclarativeEngine *engine, const char *uri) diff --git a/src/declarative/qml/qdeclarativeimageprovider.cpp b/src/declarative/qml/qdeclarativeimageprovider.cpp index daa2e87..9ef8545 100644 --- a/src/declarative/qml/qdeclarativeimageprovider.cpp +++ b/src/declarative/qml/qdeclarativeimageprovider.cpp @@ -52,6 +52,10 @@ QT_BEGIN_NAMESPACE \sa QDeclarativeEngine::addImageProvider() */ + +/*! + The destructor is virtual. + */ QDeclarativeImageProvider::~QDeclarativeImageProvider() { } diff --git a/src/declarative/qml/qdeclarativeproperty.cpp b/src/declarative/qml/qdeclarativeproperty.cpp index d223502..945d098 100644 --- a/src/declarative/qml/qdeclarativeproperty.cpp +++ b/src/declarative/qml/qdeclarativeproperty.cpp @@ -773,7 +773,8 @@ QVariant QDeclarativeProperty::read(QObject *object, const QString &name) } /*! - Return the \a name property value of \a object. This method is + Return the \a name property value of \a object using the + \l{QDeclarativeContext} {context} \a ctxt. This method is equivalent to: \code diff --git a/src/declarative/util/qdeclarativeanimation.cpp b/src/declarative/util/qdeclarativeanimation.cpp index 8c8dd95..20449d7 100644 --- a/src/declarative/util/qdeclarativeanimation.cpp +++ b/src/declarative/util/qdeclarativeanimation.cpp @@ -838,10 +838,10 @@ void QDeclarativePropertyAction::setProperty(const QString &n) } /*! + \qmlproperty list PropertyAction::targets \qmlproperty string PropertyAction::property \qmlproperty string PropertyAction::properties \qmlproperty Object PropertyAction::target - \qmlproperty list PropertyAction::targets These properties are used as a set to determine which properties should be affected by this action. @@ -876,6 +876,7 @@ QDeclarativeListProperty QDeclarativePropertyAction::targets() /*! \qmlproperty list PropertyAction::exclude This property holds the objects not to be affected by this animation. + \sa targets */ QDeclarativeListProperty QDeclarativePropertyAction::exclude() @@ -2220,7 +2221,7 @@ QDeclarativeListProperty QDeclarativePropertyAnimation::targets() /*! \qmlproperty list PropertyAnimation::exclude This property holds the items not to be affected by this animation. - \sa targets + \sa PropertyAnimation::targets */ QDeclarativeListProperty QDeclarativePropertyAnimation::exclude() { @@ -2428,11 +2429,12 @@ void QDeclarativePropertyAnimation::transition(QDeclarativeStateActions &actions be run in parallel (like those in a ParallelAnimation group). In some cases, such as reparenting between items with clipping, it's useful - to animate the parent change \i via another item with no clipping. + to animate the parent change via another item with no clipping. When used in a transition, ParentAnimation will by default animate all ParentChanges. */ + /*! \internal \class QDeclarativeParentAnimation diff --git a/src/declarative/util/qdeclarativestateoperations.cpp b/src/declarative/util/qdeclarativestateoperations.cpp index cd06380..766d1bc 100644 --- a/src/declarative/util/qdeclarativestateoperations.cpp +++ b/src/declarative/util/qdeclarativestateoperations.cpp @@ -561,9 +561,6 @@ QString QDeclarativeStateChangeScript::typeName() const \qmlclass AnchorChanges QDeclarativeAnchorChanges \brief The AnchorChanges element allows you to change the anchors of an item in a state. - In the following example we change the top and bottom anchors of an item: - \snippet examples/declarative/anchors/anchor-changes.qml 0 - AnchorChanges will 'inject' \c x, \c y, \c width, and \c height changes into the transition, so you can animate them as you would normally changes to these properties: \qml diff --git a/src/gui/painting/qcolor.cpp b/src/gui/painting/qcolor.cpp index cd448a7..08d5572 100644 --- a/src/gui/painting/qcolor.cpp +++ b/src/gui/painting/qcolor.cpp @@ -543,7 +543,8 @@ void QColor::setNamedColor(const QString &name) be used to construct a valid QColor object, otherwise returns false. - The algorithm used is the same as with \a setNamedColor(). + It uses the same algorithm used in setNamedColor(). + \sa setNamedColor() */ bool QColor::isValidColor(const QString &name) @@ -2716,12 +2717,4 @@ QDataStream &operator>>(QDataStream &stream, QColor &color) \sa QColor::rgb(), QColor::rgba() */ -/*! \fn void QColormap::initialize() - \internal -*/ - -/*! \fn void QColormap::cleanup() - \internal -*/ - QT_END_NAMESPACE diff --git a/src/gui/painting/qpainter.cpp b/src/gui/painting/qpainter.cpp index 9d83718..066725e 100644 --- a/src/gui/painting/qpainter.cpp +++ b/src/gui/painting/qpainter.cpp @@ -5758,18 +5758,18 @@ void QPainterPrivate::drawGlyphs(const quint32 *glyphArray, const QPointF *posit /*! \fn void QPainter::drawStaticText(const QPoint &position, const QStaticText &staticText) - \since 4.7 - \overload + + Draws the \a staticText at the \a position. */ /*! \fn void QPainter::drawStaticText(int x, int y, const QStaticText &staticText) - \since 4.7 - \overload + + Draws the \a staticText at coordinates \a x and \a y. */ /*! diff --git a/src/gui/text/qstatictext.cpp b/src/gui/text/qstatictext.cpp index 8fe4c47..1fabf12 100644 --- a/src/gui/text/qstatictext.cpp +++ b/src/gui/text/qstatictext.cpp @@ -282,8 +282,10 @@ QString QStaticText::text() const } /*! - Sets the performance hint of the QStaticText. This hint can be used to customize how much - caching is done internally to improve performance. + Sets the performance hint of the QStaticText according to the \a + performanceHint provided. The \a performanceHint is used to + customize how much caching is done internally to improve + performance. The default is QStaticText::ModerateCaching. diff --git a/src/multimedia/effects/qsoundeffect.cpp b/src/multimedia/effects/qsoundeffect.cpp index f64d9ee..a5cb20f 100644 --- a/src/multimedia/effects/qsoundeffect.cpp +++ b/src/multimedia/effects/qsoundeffect.cpp @@ -71,8 +71,6 @@ QT_BEGIN_NAMESPACE } } \endqml - - \sa SoundEffect */ /*! -- cgit v0.12