From 7a1891b2f308377e67204bbc812716cbc148af4a Mon Sep 17 00:00:00 2001 From: Volker Hilsheimer Date: Sun, 19 Jul 2009 22:42:08 +0200 Subject: Doc: add \since 4.6 for new APIs --- doc/src/qdesktopwidget.qdoc | 4 ++++ src/3rdparty/webkit/WebKit/qt/Api/qwebpage.cpp | 2 ++ src/corelib/kernel/qmetaobject.cpp | 2 ++ src/corelib/tools/qcontiguouscache.cpp | 1 + src/corelib/tools/qpoint.cpp | 2 ++ src/corelib/tools/qtimeline.cpp | 2 ++ src/gui/graphicsview/qgraphicsitem.cpp | 24 ++++++++++++++-------- src/gui/graphicsview/qgraphicslayoutitem.cpp | 4 ++++ src/gui/graphicsview/qgraphicsscene.cpp | 2 ++ src/gui/graphicsview/qgraphicsview.cpp | 2 ++ src/gui/image/qpixmap.cpp | 3 +++ src/gui/text/qabstracttextdocumentlayout.cpp | 1 + src/gui/text/qtextcursor.cpp | 2 ++ src/network/access/qabstractnetworkcache.cpp | 4 ++++ src/opengl/qglframebufferobject.cpp | 24 ---------------------- src/script/qscriptvalue.cpp | 16 +++++++++------ src/sql/kernel/qsqldatabase.cpp | 28 ++++++++++++++++---------- src/sql/kernel/qsqldriver.cpp | 26 +++++++++++++++--------- src/testlib/qtestcase.cpp | 6 ------ src/xmlpatterns/api/qabstractxmlnodemodel.cpp | 10 ++++----- 20 files changed, 96 insertions(+), 69 deletions(-) diff --git a/doc/src/qdesktopwidget.qdoc b/doc/src/qdesktopwidget.qdoc index 383ccfc..56a882d 100644 --- a/doc/src/qdesktopwidget.qdoc +++ b/doc/src/qdesktopwidget.qdoc @@ -233,6 +233,8 @@ /*! \property QDesktopWidget::screenCount \brief the number of screens currently available on the system. + + \since 4.6 \sa screenCountChanged() */ @@ -256,6 +258,8 @@ /*! \fn void QDesktopWidget::screenCountChanged(int newCount) + \since 4.6 + This signal is emitted when the number of screens changes to \a newCount. \sa screenCount diff --git a/src/3rdparty/webkit/WebKit/qt/Api/qwebpage.cpp b/src/3rdparty/webkit/WebKit/qt/Api/qwebpage.cpp index 84753bd..3c2151b 100644 --- a/src/3rdparty/webkit/WebKit/qt/Api/qwebpage.cpp +++ b/src/3rdparty/webkit/WebKit/qt/Api/qwebpage.cpp @@ -1315,6 +1315,8 @@ QWebFrame *QWebPage::currentFrame() const /*! + \since 4.6 + Returns the frame at the given point \a pos. \sa mainFrame(), currentFrame() diff --git a/src/corelib/kernel/qmetaobject.cpp b/src/corelib/kernel/qmetaobject.cpp index 3184244..08cecaf 100644 --- a/src/corelib/kernel/qmetaobject.cpp +++ b/src/corelib/kernel/qmetaobject.cpp @@ -2304,6 +2304,8 @@ QMetaMethod QMetaProperty::notifySignal() const } /*! + \since 4.6 + Returns the index of the property change notifying signal if one was specified, otherwise returns -1. diff --git a/src/corelib/tools/qcontiguouscache.cpp b/src/corelib/tools/qcontiguouscache.cpp index e738ec8..8a14152 100644 --- a/src/corelib/tools/qcontiguouscache.cpp +++ b/src/corelib/tools/qcontiguouscache.cpp @@ -61,6 +61,7 @@ void QContiguousCacheData::dump() const \ingroup tools \ingroup shared \reentrant + \since 4.6 The QContiguousCache class provides an efficient way of caching items for display in a user interface view. Unlike QCache, it adds a restriction diff --git a/src/corelib/tools/qpoint.cpp b/src/corelib/tools/qpoint.cpp index 49afdca..af60f52 100644 --- a/src/corelib/tools/qpoint.cpp +++ b/src/corelib/tools/qpoint.cpp @@ -444,6 +444,8 @@ QDebug operator<<(QDebug d, const QPointF &p) /*! + \since 4.6 + Returns the sum of the absolute values of x() and y(), traditionally known as the "Manhattan length" of the vector from the origin to the point. diff --git a/src/corelib/tools/qtimeline.cpp b/src/corelib/tools/qtimeline.cpp index 04aed39..e32fc03 100644 --- a/src/corelib/tools/qtimeline.cpp +++ b/src/corelib/tools/qtimeline.cpp @@ -555,6 +555,8 @@ void QTimeLine::setCurveShape(CurveShape shape) /*! \property QTimeLine::easingCurve + \since 4.6 + Specifies the easing curve that the timeline will use. If both easing curve and curveShape are set, the last set property will override the previous one. (If valueForTime() is reimplemented it will diff --git a/src/gui/graphicsview/qgraphicsitem.cpp b/src/gui/graphicsview/qgraphicsitem.cpp index cb0418c..7d5ce7b 100644 --- a/src/gui/graphicsview/qgraphicsitem.cpp +++ b/src/gui/graphicsview/qgraphicsitem.cpp @@ -1260,7 +1260,7 @@ QGraphicsItem *QGraphicsItem::topLevelItem() const } /*! - \since 4.4 + \since 4.6 Returns a pointer to the item's parent, cast to a QGraphicsObject. returns 0 if the parent item is not a QGraphicsObject. @@ -2361,6 +2361,8 @@ void QGraphicsItem::setAcceptTouchEvents(bool enabled) } /*! + \since 4.6 + Returns true if this item filters child events (i.e., all events intended for any of its children are instead sent to this item); otherwise, false is returned. @@ -2375,13 +2377,15 @@ bool QGraphicsItem::filtersChildEvents() const } /*! + \since 4.6 + If \a enabled is true, this item is set to filter all events for all its children (i.e., all events intented for any of its children are instead sent to this item); otherwise, if \a enabled is false, this item will only handle its own events. The default value is false. - \sa filtersChildEvents() + \sa filtersChildEvents() */ void QGraphicsItem::setFiltersChildEvents(bool enabled) { @@ -2661,10 +2665,12 @@ QPointF QGraphicsItem::pos() const */ /*! - Set's the \a x coordinate of the item's position. Equivalent to - calling setPos(x, y()). + \since 4.6 + + Set's the \a x coordinate of the item's position. Equivalent to + calling setPos(x, y()). - \sa x(), setPos() + \sa x(), setPos() */ void QGraphicsItem::setX(qreal x) { @@ -2680,10 +2686,12 @@ void QGraphicsItem::setX(qreal x) */ /*! - Set's the \a y coordinate of the item's position. Equivalent to - calling setPos(x(), y). + \since 4.6 + + Set's the \a y coordinate of the item's position. Equivalent to + calling setPos(x(), y). - \sa x(), setPos() + \sa x(), setPos() */ void QGraphicsItem::setY(qreal y) { diff --git a/src/gui/graphicsview/qgraphicslayoutitem.cpp b/src/gui/graphicsview/qgraphicslayoutitem.cpp index 656af33..e280162 100644 --- a/src/gui/graphicsview/qgraphicslayoutitem.cpp +++ b/src/gui/graphicsview/qgraphicslayoutitem.cpp @@ -808,6 +808,8 @@ bool QGraphicsLayoutItem::isLayout() const } /*! + \since 4.6 + Returns whether a layout should delete this item in its destructor. If its true, then the layout will delete it. If its false, then it is assumed that another object has the ownership of it, and the layout won't @@ -834,6 +836,8 @@ bool QGraphicsLayoutItem::ownedByLayout() const return d_func()->ownedByLayout; } /*! + \since 4.6 + Sets whether a layout should delete this item in its destructor or not. \a ownership must be true to in order for the layout to delete it. \sa ownedByLayout() diff --git a/src/gui/graphicsview/qgraphicsscene.cpp b/src/gui/graphicsview/qgraphicsscene.cpp index 53aea58..38e5938 100644 --- a/src/gui/graphicsview/qgraphicsscene.cpp +++ b/src/gui/graphicsview/qgraphicsscene.cpp @@ -2675,6 +2675,8 @@ void QGraphicsScene::clearFocus() \property QGraphicsScene::stickyFocus \brief whether or not clicking the scene will clear focus + \since 4.6 + If this property is false (the default), then clicking on the scene background or on an item that does not accept focus, will clear focus. Otherwise, focus will remain unchanged. diff --git a/src/gui/graphicsview/qgraphicsview.cpp b/src/gui/graphicsview/qgraphicsview.cpp index 1cea8db..6ef226d 100644 --- a/src/gui/graphicsview/qgraphicsview.cpp +++ b/src/gui/graphicsview/qgraphicsview.cpp @@ -3552,6 +3552,8 @@ QTransform QGraphicsView::viewportTransform() const } /*! + \since 4.6 + Returns true if the view is transformed (i.e., a non-identity transform has been assigned, or the scrollbars are adjusted). diff --git a/src/gui/image/qpixmap.cpp b/src/gui/image/qpixmap.cpp index 61be832..15bbccb 100644 --- a/src/gui/image/qpixmap.cpp +++ b/src/gui/image/qpixmap.cpp @@ -380,6 +380,7 @@ QPixmap QPixmap::copy(const QRect &rect) const /*! \fn QPixmap::scroll(int dx, int dy, int x, int y, int width, int height, QRegion *exposed) + \since 4.6 This convenience function is equivalent to calling QPixmap::scroll(\a dx, \a dy, QRect(\a x, \a y, \a width, \a height), \a exposed). @@ -388,6 +389,8 @@ QPixmap QPixmap::copy(const QRect &rect) const */ /*! + \since 4.6 + Scrolls the area \a rect of this pixmap by (\a dx, \a dy). The exposed region is left unchanged. You can optionally pass a pointer to an empty QRegion to get the region that is \a exposed by the scroll operation. diff --git a/src/gui/text/qabstracttextdocumentlayout.cpp b/src/gui/text/qabstracttextdocumentlayout.cpp index 8d7540c..04df2aa 100644 --- a/src/gui/text/qabstracttextdocumentlayout.cpp +++ b/src/gui/text/qabstracttextdocumentlayout.cpp @@ -79,6 +79,7 @@ QT_BEGIN_NAMESPACE \class QTextObjectInterface \brief The QTextObjectInterface class allows drawing of custom text objects in \l{QTextDocument}s. + \since 4.5 A text object describes the structure of one or more elements in a text document; for instance, images imported from HTML are diff --git a/src/gui/text/qtextcursor.cpp b/src/gui/text/qtextcursor.cpp index 0e3cb56..19d4cc4 100644 --- a/src/gui/text/qtextcursor.cpp +++ b/src/gui/text/qtextcursor.cpp @@ -1856,6 +1856,8 @@ bool QTextCursor::atStart() const } /*! + \since 4.6 + Returns true if the cursor is at the end of the document; otherwise returns false. diff --git a/src/network/access/qabstractnetworkcache.cpp b/src/network/access/qabstractnetworkcache.cpp index cfc9fe7..3f44059 100644 --- a/src/network/access/qabstractnetworkcache.cpp +++ b/src/network/access/qabstractnetworkcache.cpp @@ -283,6 +283,8 @@ void QNetworkCacheMetaData::setExpirationDate(const QDateTime &dateTime) } /*! + \since 4.6 + Returns all the attributes stored with this cache item. \sa setAttributes(), QNetworkRequest::Attribute @@ -293,6 +295,8 @@ QNetworkCacheMetaData::AttributesMap QNetworkCacheMetaData::attributes() const } /*! + \since 4.6 + Sets all attributes of this cache item to be the map \a attributes. \sa attributes(), QNetworkRequest::setAttribute() diff --git a/src/opengl/qglframebufferobject.cpp b/src/opengl/qglframebufferobject.cpp index eacf5bb..df89e24 100644 --- a/src/opengl/qglframebufferobject.cpp +++ b/src/opengl/qglframebufferobject.cpp @@ -109,8 +109,6 @@ public: */ /*! - \since 4.6 - Creates a QGLFramebufferObjectFormat object with properties specifying the format of an OpenGL framebuffer object. @@ -146,8 +144,6 @@ QGLFramebufferObjectFormat::QGLFramebufferObjectFormat(int samples, } /*! - \since 4.6 - Constructs a copy of \a other. */ @@ -158,8 +154,6 @@ QGLFramebufferObjectFormat::QGLFramebufferObjectFormat(const QGLFramebufferObjec } /*! - \since 4.6 - Assigns \a other to this object. */ @@ -170,8 +164,6 @@ QGLFramebufferObjectFormat &QGLFramebufferObjectFormat::operator=(const QGLFrame } /*! - \since 4.6 - Destroys the QGLFramebufferObjectFormat. */ QGLFramebufferObjectFormat::~QGLFramebufferObjectFormat() @@ -180,8 +172,6 @@ QGLFramebufferObjectFormat::~QGLFramebufferObjectFormat() } /*! - \since 4.6 - Sets the number of samples per pixel for a multisample framebuffer object to \a samples. A sample count of 0 represents a regular non-multisample framebuffer object. @@ -194,8 +184,6 @@ void QGLFramebufferObjectFormat::setSamples(int samples) } /*! - \since 4.6 - Returns the number of samples per pixel if a framebuffer object is a multisample framebuffer object. Otherwise, returns 0. @@ -207,8 +195,6 @@ int QGLFramebufferObjectFormat::samples() const } /*! - \since 4.6 - Sets the attachments a framebuffer object should have to \a attachment. \sa attachment() @@ -219,8 +205,6 @@ void QGLFramebufferObjectFormat::setAttachment(QGLFramebufferObject::Attachment } /*! - \since 4.6 - Returns the status of the depth and stencil buffers attached to a framebuffer object. @@ -232,8 +216,6 @@ QGLFramebufferObject::Attachment QGLFramebufferObjectFormat::attachment() const } /*! - \since 4.6 - Sets the texture target of the texture attached to a framebuffer object to \a target. Ignored for multisample framebuffer objects. @@ -245,8 +227,6 @@ void QGLFramebufferObjectFormat::setTextureTarget(GLenum target) } /*! - \since 4.6 - Returns the texture target of the texture attached to a framebuffer object. Ignored for multisample framebuffer objects. @@ -258,8 +238,6 @@ GLenum QGLFramebufferObjectFormat::textureTarget() const } /*! - \since 4.6 - Sets the internal format of a framebuffer object's texture or multisample framebuffer object's color buffer to \a internalFormat. @@ -271,8 +249,6 @@ void QGLFramebufferObjectFormat::setInternalFormat(GLenum internalFormat) } /*! - \since 4.6 - Returns the internal format of a framebuffer object's texture or multisample framebuffer object's color buffer. diff --git a/src/script/qscriptvalue.cpp b/src/script/qscriptvalue.cpp index 97ce61a..48e1318 100644 --- a/src/script/qscriptvalue.cpp +++ b/src/script/qscriptvalue.cpp @@ -574,9 +574,11 @@ void QScriptValue::setPrototype(const QScriptValue &prototype) } /*! - Returns the scope object of this QScriptValue. This function is only - relevant for function objects. The scope determines how variables are - resolved when the function is invoked. + \since 4.6 + + Returns the scope object of this QScriptValue. This function is only + relevant for function objects. The scope determines how variables are + resolved when the function is invoked. */ QScriptValue QScriptValue::scope() const { @@ -588,9 +590,11 @@ QScriptValue QScriptValue::scope() const } /*! - Sets the \a scope object of this QScriptValue. This function is only - relevant for function objects. Changing the scope is useful when creating - closures; see \l{Nested Functions and the Scope Chain}. + \since 4.6 + + Sets the \a scope object of this QScriptValue. This function is only + relevant for function objects. Changing the scope is useful when creating + closures; see \l{Nested Functions and the Scope Chain}. */ void QScriptValue::setScope(const QScriptValue &scope) { diff --git a/src/sql/kernel/qsqldatabase.cpp b/src/sql/kernel/qsqldatabase.cpp index 5aef39e..4950303 100644 --- a/src/sql/kernel/qsqldatabase.cpp +++ b/src/sql/kernel/qsqldatabase.cpp @@ -1481,18 +1481,21 @@ QString QSqlDatabase::connectionName() const } /*! - Sets the default numerical precision policy used by queries created - on this database connection to \a precisionPolicy. + \since 4.6 - Note: Drivers that don't support fetching numerical values with low - precision will ignore the precision policy. You can use - QSqlDriver::hasFeature() to find out whether a driver supports this - feature. + Sets the default numerical precision policy used by queries created + on this database connection to \a precisionPolicy. - Note: Setting the default precision policy to \a precisionPolicy - doesn't affect any currently active queries. + Note: Drivers that don't support fetching numerical values with low + precision will ignore the precision policy. You can use + QSqlDriver::hasFeature() to find out whether a driver supports this + feature. - \sa QSql::NumericalPrecisionPolicy, numericalPrecisionPolicy(), QSqlQuery::setNumericalPrecisionPolicy(), QSqlQuery::numericalPrecisionPolicy() + Note: Setting the default precision policy to \a precisionPolicy + doesn't affect any currently active queries. + + \sa QSql::NumericalPrecisionPolicy, numericalPrecisionPolicy(), + QSqlQuery::setNumericalPrecisionPolicy(), QSqlQuery::numericalPrecisionPolicy() */ void QSqlDatabase::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy) { @@ -1502,9 +1505,12 @@ void QSqlDatabase::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy pr } /*! - Returns the current default precision policy for the database connection. + \since 4.6 + + Returns the current default precision policy for the database connection. - \sa QSql::NumericalPrecisionPolicy, setNumericalPrecisionPolicy(), QSqlQuery::numericalPrecisionPolicy(), QSqlQuery::setNumericalPrecisionPolicy() + \sa QSql::NumericalPrecisionPolicy, setNumericalPrecisionPolicy(), + QSqlQuery::numericalPrecisionPolicy(), QSqlQuery::setNumericalPrecisionPolicy() */ QSql::NumericalPrecisionPolicy QSqlDatabase::numericalPrecisionPolicy() const { diff --git a/src/sql/kernel/qsqldriver.cpp b/src/sql/kernel/qsqldriver.cpp index 77e389f..ca0da66 100644 --- a/src/sql/kernel/qsqldriver.cpp +++ b/src/sql/kernel/qsqldriver.cpp @@ -865,6 +865,8 @@ QStringList QSqlDriver::subscribedToNotificationsImplementation() const } /*! + \since 4.6 + This slot returns whether \a identifier is escaped according to the database rules. \a identifier can either be a table name or field name, dependent on \a type. @@ -876,7 +878,6 @@ QStringList QSqlDriver::subscribedToNotificationsImplementation() const slot in your own QSqlDriver if your database engine uses a different delimiter character. - \since 4.5 \sa isIdentifierEscaped() */ bool QSqlDriver::isIdentifierEscapedImplementation(const QString &identifier, IdentifierType type) const @@ -888,6 +889,8 @@ bool QSqlDriver::isIdentifierEscapedImplementation(const QString &identifier, Id } /*! + \since 4.6 + This slot returns \a identifier with the leading and trailing delimiters removed, \a identifier can either be a tablename or field name, dependent on \a type. If \a identifier does not have leading and trailing delimiter characters, \a @@ -898,7 +901,6 @@ bool QSqlDriver::isIdentifierEscapedImplementation(const QString &identifier, Id dynamically detect and call \e this slot. It generally unnecessary to reimplement this slot. - \since 4.5 \sa stripDelimiters() */ QString QSqlDriver::stripDelimitersImplementation(const QString &identifier, IdentifierType type) const @@ -914,13 +916,16 @@ QString QSqlDriver::stripDelimitersImplementation(const QString &identifier, Ide } /*! - Sets the default numerical precision policy used by queries created - by this driver to \a precisionPolicy. + \since 4.6 + + Sets the default numerical precision policy used by queries created + by this driver to \a precisionPolicy. - Note: Setting the default precision policy to \a precisionPolicy - doesn't affect any currently active queries. + Note: Setting the default precision policy to \a precisionPolicy + doesn't affect any currently active queries. - \sa QSql::NumericalPrecisionPolicy, numericalPrecisionPolicy(), QSqlQuery::setNumericalPrecisionPolicy(), QSqlQuery::numericalPrecisionPolicy() + \sa QSql::NumericalPrecisionPolicy, numericalPrecisionPolicy(), + QSqlQuery::setNumericalPrecisionPolicy(), QSqlQuery::numericalPrecisionPolicy() */ void QSqlDriver::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy) { @@ -928,9 +933,12 @@ void QSqlDriver::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy prec } /*! - Returns the current default precision policy for the database connection. + \since 4.6 + + Returns the current default precision policy for the database connection. - \sa QSql::NumericalPrecisionPolicy, setNumericalPrecisionPolicy(), QSqlQuery::numericalPrecisionPolicy(), QSqlQuery::setNumericalPrecisionPolicy() + \sa QSql::NumericalPrecisionPolicy, setNumericalPrecisionPolicy(), + QSqlQuery::numericalPrecisionPolicy(), QSqlQuery::setNumericalPrecisionPolicy() */ QSql::NumericalPrecisionPolicy QSqlDriver::numericalPrecisionPolicy() const { diff --git a/src/testlib/qtestcase.cpp b/src/testlib/qtestcase.cpp index e9d58f9..70c8c8d 100644 --- a/src/testlib/qtestcase.cpp +++ b/src/testlib/qtestcase.cpp @@ -714,14 +714,12 @@ QT_BEGIN_NAMESPACE /*! \fn QTest::QTouchEventSequence::~QTouchEventSequence() - \since 4.6 Commits this sequence of touch events and frees allocated resources. */ /*! \fn QTouchEventSequence &QTest::QTouchEventSequence::press(int touchId, const QPoint &pt, QWidget *widget) - \since 4.6 Adds a press event for touchpoint \a touchId at position \a pt to this sequence and returns a reference to this QTouchEventSequence. @@ -734,7 +732,6 @@ QT_BEGIN_NAMESPACE /*! \fn QTouchEventSequence &QTest::QTouchEventSequence::move(int touchId, const QPoint &pt, QWidget *widget) - \since 4.6 Adds a move event for touchpoint \a touchId at position \a pt to this sequence and returns a reference to this QTouchEventSequence. @@ -747,7 +744,6 @@ QT_BEGIN_NAMESPACE /*! \fn QTouchEventSequence &QTest::QTouchEventSequence::release(int touchId, const QPoint &pt, QWidget *widget) - \since 4.6 Adds a release event for touchpoint \a touchId at position \a pt to this sequence and returns a reference to this QTouchEventSequence. @@ -760,7 +756,6 @@ QT_BEGIN_NAMESPACE /*! \fn QTouchEventSequence &QTest::QTouchEventSequence::stationary(int touchId) - \since 4.6 Adds a stationary event for touchpoint \a touchId to this sequence and returns a reference to this QTouchEventSequence. @@ -770,7 +765,6 @@ QT_BEGIN_NAMESPACE /*! \fn QTouchEventSequence QTest::touchEvent(QWidget *widget, QTouchEvent::DeviceType deviceType) - \since 4.6 Creates and returns a QTouchEventSequence for the device \a deviceType to simulate events for \a widget. diff --git a/src/xmlpatterns/api/qabstractxmlnodemodel.cpp b/src/xmlpatterns/api/qabstractxmlnodemodel.cpp index 0a2ca91..06f03e6 100644 --- a/src/xmlpatterns/api/qabstractxmlnodemodel.cpp +++ b/src/xmlpatterns/api/qabstractxmlnodemodel.cpp @@ -1667,12 +1667,12 @@ void QAbstractXmlNodeModel::copyNodeTo(const QXmlNodeModelIndex &node, } /*! - Returns the source location for the object with the given \a index - or a default constructed QSourceLocation in case no location - information is available. + Returns the source location for the object with the given \a index + or a default constructed QSourceLocation in case no location + information is available. - \since TODO - */ + \since 4.6 +*/ QSourceLocation QAbstractXmlNodeModel::sourceLocation(const QXmlNodeModelIndex &index) const { // TODO: make this method virtual in Qt5 to allow source location support in custom models -- cgit v0.12