From e39feabbcdb10b47c7eaad14fe653e62280e6237 Mon Sep 17 00:00:00 2001 From: Martin Smith Date: Thu, 4 Feb 2010 15:00:37 +0100 Subject: doc: Fixed some qdoc warnings. --- src/corelib/kernel/qcoreevent.cpp | 1 - src/gui/image/qpixmap.cpp | 9 +++++---- src/network/access/qnetworkreply.cpp | 9 +++++++++ src/network/access/qnetworkrequest.cpp | 17 ++++++++++++++--- src/opengl/qgl.cpp | 14 ++++++++------ 5 files changed, 36 insertions(+), 14 deletions(-) diff --git a/src/corelib/kernel/qcoreevent.cpp b/src/corelib/kernel/qcoreevent.cpp index d177b26..16b8798 100644 --- a/src/corelib/kernel/qcoreevent.cpp +++ b/src/corelib/kernel/qcoreevent.cpp @@ -272,7 +272,6 @@ QT_BEGIN_NAMESPACE \omitvalue MacGLClearDrawable \omitvalue NetworkReplyUpdated \omitvalue FutureCallOut - \omitvalue CocoaRequestModal \omitvalue UpdateSoftKeys \omitvalue NativeGesture */ diff --git a/src/gui/image/qpixmap.cpp b/src/gui/image/qpixmap.cpp index fe03c93..e51d858 100644 --- a/src/gui/image/qpixmap.cpp +++ b/src/gui/image/qpixmap.cpp @@ -1379,10 +1379,11 @@ void QPixmap::deref() */ /*! - Replaces this pixmap's data with the given \a image using the specified - \a flags to control the conversion. The \a flags argument is a - bitwise-OR of the \l{Qt::ImageConversionFlags}. Passing 0 for \a - flags sets all the default options. + Replaces this pixmap's data with the given \a image using the + specified \a flags to control the conversion. The \a flags + argument is a bitwise-OR of the \l{Qt::ImageConversionFlags}. + Passing 0 for \a flags sets all the default options. Returns true + if the result is that this pixmap is not null. Note: this function was part of Qt 3 support in Qt 4.6 and earlier. It has been promoted to official API status in 4.7 to support updating diff --git a/src/network/access/qnetworkreply.cpp b/src/network/access/qnetworkreply.cpp index be4339c..15748fe 100644 --- a/src/network/access/qnetworkreply.cpp +++ b/src/network/access/qnetworkreply.cpp @@ -533,6 +533,15 @@ QByteArray QNetworkReply::rawHeader(const QByteArray &headerName) const return QByteArray(); } +/*! \typedef QNetworkReply::RawHeaderPair + + RawHeaderPair is a QPair where the first + QByteArray is the header name and the second is the header. + */ + +/*! + Returns a list of raw header pairs. + */ const QList& QNetworkReply::rawHeaderPairs() const { Q_D(const QNetworkReply); diff --git a/src/network/access/qnetworkrequest.cpp b/src/network/access/qnetworkrequest.cpp index 52b88a3..b8438a2 100644 --- a/src/network/access/qnetworkrequest.cpp +++ b/src/network/access/qnetworkrequest.cpp @@ -532,13 +532,24 @@ QNetworkRequest::Priority QNetworkRequest::priority() const return d->priority; } +/*! \enum QNetworkRequest::Priority + + \since 4.7 + + This enum lists the possible network request priorities. + + \value HighPriority High priority + \value NormalPriority Normal priority + \value LowPriority Low priority + */ + /*! \since 4.7 - Set the priority of this request. + Set the priority of this request to \a priority. - \note The priority is only a hint to the network access manager. - It can use it or not. Currently it is used for HTTP to + \note The \a priority is only a hint to the network access + manager. It can use it or not. Currently it is used for HTTP to decide which request should be sent first to a server. \sa priority() diff --git a/src/opengl/qgl.cpp b/src/opengl/qgl.cpp index bb76f1a..97b1c2f 100644 --- a/src/opengl/qgl.cpp +++ b/src/opengl/qgl.cpp @@ -1085,8 +1085,9 @@ int QGLFormat::stencilBufferSize() const /*! \since 4.7 - Set the OpenGL version. If a context compatible with the requested OpenGL version - cannot be created, a context compatible with version 1.x is created instead. + Set the OpenGL version to the \a major and \a minor numbers. If a + context compatible with the requested OpenGL version cannot be + created, a context compatible with version 1.x is created instead. \sa majorVersion(), minorVersion() */ @@ -1129,8 +1130,9 @@ int QGLFormat::minorVersion() const \enum QGLFormat::OpenGLContextProfile \since 4.7 - This enum describes the OpenGL context profiles that can be specified for contexts implementing - OpenGL version 3.2 or higher. These profiles are different from OpenGL ES profiles. + This enum describes the OpenGL context profiles that can be + specified for contexts implementing OpenGL version 3.2 or + higher. These profiles are different from OpenGL ES profiles. \value NoProfile OpenGL version is lower than 3.2. \value CoreProfile Functionality deprecated in OpenGL version 3.0 is not available. @@ -1140,8 +1142,8 @@ int QGLFormat::minorVersion() const /*! \since 4.7 - Set the OpenGL context profile. The profile is ignored if the requested OpenGL - version is less than 3.2. + Set the OpenGL context profile to \a profile. The \a profile is + ignored if the requested OpenGL version is less than 3.2. \sa profile() */ -- cgit v0.12