diff options
author | Friedemann Kleint <Friedemann.Kleint@digia.com> | 2014-03-24 16:20:11 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-03-24 16:42:02 +0100 |
commit | 3ed2ec14870c4035cfd1bd986f6d8f4f55890270 (patch) | |
tree | cbbc272c325413f482845d6dcd0e2241ab435553 /src | |
parent | 21f1738a94fc8544ece04b3b1ee03a11986fe59b (diff) |
Fix some documentation errors.
Correct links and fix typos, remove obsolete documentation,
fix some snippets, mark some classes as internal.
Change-Id: I9a3266605f060783413d32740057a57a820c8929
Reviewed-by: Laszlo Agocs <laszlo.agocs@digia.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/corelib/kernel/qmimedata.cpp | 2 | ||||
-rw-r--r-- | src/corelib/kernel/qobject.cpp | 6 | ||||
-rw-r--r-- | src/corelib/tools/qmargins.cpp | 20 | ||||
-rw-r--r-- | src/corelib/tools/qstring.cpp | 4 | ||||
-rw-r--r-- | src/corelib/xml/qxmlstream.cpp | 4 | ||||
-rw-r--r-- | src/dbus/qdbusreply.cpp | 7 | ||||
-rw-r--r-- | src/gui/image/qimage.cpp | 2 | ||||
-rw-r--r-- | src/gui/kernel/qdrag.cpp | 2 | ||||
-rw-r--r-- | src/gui/kernel/qevent.cpp | 4 | ||||
-rw-r--r-- | src/gui/kernel/qopenglcontext.cpp | 4 | ||||
-rw-r--r-- | src/gui/kernel/qsessionmanager.cpp | 8 | ||||
-rw-r--r-- | src/gui/kernel/qsurfaceformat.cpp | 2 | ||||
-rw-r--r-- | src/gui/opengl/qopengltexture.cpp | 14 | ||||
-rw-r--r-- | src/opengl/qgl.cpp | 47 | ||||
-rw-r--r-- | src/opengl/qglfunctions.cpp | 4 | ||||
-rw-r--r-- | src/sql/kernel/qsqlquery.cpp | 2 |
16 files changed, 55 insertions, 77 deletions
diff --git a/src/corelib/kernel/qmimedata.cpp b/src/corelib/kernel/qmimedata.cpp index 483692cdf8..5d2adb0561 100644 --- a/src/corelib/kernel/qmimedata.cpp +++ b/src/corelib/kernel/qmimedata.cpp @@ -299,7 +299,7 @@ QVariant QMimeDataPrivate::retrieveTypedData(const QString &format, QVariant::Ty QMacPasteboardMime maps MIME to Mac flavors. \sa QClipboard, QDragEnterEvent, QDragMoveEvent, QDropEvent, QDrag, - QWindowsMime, QMacPasteboardMime, {Drag and Drop} + QMacPasteboardMime, {Drag and Drop} */ /*! diff --git a/src/corelib/kernel/qobject.cpp b/src/corelib/kernel/qobject.cpp index 262d259136..01bedb4a3a 100644 --- a/src/corelib/kernel/qobject.cpp +++ b/src/corelib/kernel/qobject.cpp @@ -551,7 +551,7 @@ void QMetaCallEvent::placeMetaCall(QObject *object) QObject::signalsBlocked() state is transferred to this object. The object's signals this signal blocker was blocking prior to - being moved to, if any, are unblocked \em except in the case where + being moved to, if any, are unblocked \e except in the case where both instances block the same object's signals and \c *this is unblocked while \a other is not, at the time of the move. */ @@ -2731,9 +2731,7 @@ QMetaObject::Connection QObject::connect(const QObject *sender, const char *sign Qt::ConnectionType type) but it uses QMetaMethod to specify signal and method. - \sa connect(const QObject *sender, const char *signal, - const QObject *receiver, const char *method, - Qt::ConnectionType type) + \sa connect(const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) */ QMetaObject::Connection QObject::connect(const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, diff --git a/src/corelib/tools/qmargins.cpp b/src/corelib/tools/qmargins.cpp index 03993f05a9..6f2c6c2c7c 100644 --- a/src/corelib/tools/qmargins.cpp +++ b/src/corelib/tools/qmargins.cpp @@ -334,6 +334,26 @@ QT_BEGIN_NAMESPACE */ /*! + \fn QMargins &QMargins::operator+=(int addend) + \overload + + Adds the \a addend to each component of this object + and returns a reference to it. + + \sa operator-=() +*/ + +/*! + \fn QMargins &QMargins::operator-=(int subtrahend) + \overload + + Subtracts the \a subtrahend from each component of this object + and returns a reference to it. + + \sa operator+=() +*/ + +/*! \fn QMargins &QMargins::operator*=(int factor) Multiplies each component of this object by \a factor diff --git a/src/corelib/tools/qstring.cpp b/src/corelib/tools/qstring.cpp index 7547ba8c19..a8770e886b 100644 --- a/src/corelib/tools/qstring.cpp +++ b/src/corelib/tools/qstring.cpp @@ -6168,7 +6168,7 @@ qulonglong QString::toIntegral_helper(const QChar *data, uint len, bool *ok, int \snippet qstring/main.cpp 73 - \sa number(), toULong(), toInt(), QLocale::toLong() + \sa number(), toULong(), toInt(), QLocale::toInt() */ long QString::toLong(bool *ok, int base) const @@ -6197,7 +6197,7 @@ long QString::toLong(bool *ok, int base) const \snippet qstring/main.cpp 78 - \sa number(), QLocale::toULong() + \sa number(), QLocale::toUInt() */ ulong QString::toULong(bool *ok, int base) const diff --git a/src/corelib/xml/qxmlstream.cpp b/src/corelib/xml/qxmlstream.cpp index 5461139582..83d0c73ae1 100644 --- a/src/corelib/xml/qxmlstream.cpp +++ b/src/corelib/xml/qxmlstream.cpp @@ -349,11 +349,11 @@ QXmlStreamEntityResolver *QXmlStreamReader::entityResolver() const \l{QNetworkAccessManager} {network access manager}, you would issue a \l{QNetworkRequest} {network request} to the manager and receive a \l{QNetworkReply} {network reply} in return. Since a QNetworkReply - is a QIODevice, you connect its \l{QNetworkReply::readyRead()} + is a QIODevice, you connect its \l{QIODevice::readyRead()} {readyRead()} signal to a custom slot, e.g. \c{slotReadyRead()} in the code snippet shown in the discussion for QNetworkAccessManager. In this slot, you read all available data with - \l{QNetworkReply::readAll()} {readAll()} and pass it to the XML + \l{QIODevice::readAll()} {readAll()} and pass it to the XML stream reader using addData(). Then you call your custom parsing function that reads the XML events from the reader. diff --git a/src/dbus/qdbusreply.cpp b/src/dbus/qdbusreply.cpp index b1326c11f1..551891fdf2 100644 --- a/src/dbus/qdbusreply.cpp +++ b/src/dbus/qdbusreply.cpp @@ -155,7 +155,7 @@ QT_BEGIN_NAMESPACE */ /*! - \fn QDBusReply::error() + \fn const QDBusError& QDBusReply::error() const Returns the error code that was returned from the remote function call. If the remote call did not return an error (i.e., if it succeeded), then the QDBusError object that is returned will @@ -165,6 +165,11 @@ QT_BEGIN_NAMESPACE */ /*! + \fn const QDBusError& QDBusReply::error() + \overload +*/ + +/*! \fn QDBusReply::value() const Returns the remote function's calls return value. If the remote call returned with an error, the return value of this function is undefined and may be undistinguishable from a valid return diff --git a/src/gui/image/qimage.cpp b/src/gui/image/qimage.cpp index 48c262ae7a..3998bbf3ff 100644 --- a/src/gui/image/qimage.cpp +++ b/src/gui/image/qimage.cpp @@ -611,7 +611,7 @@ bool QImageData::checkForAlphaPixels() const */ /*! - \fn QImage &operator=(QImage &&other) + \fn QImage &QImage::operator=(QImage &&other) Move-assigns \a other to this QImage instance. diff --git a/src/gui/kernel/qdrag.cpp b/src/gui/kernel/qdrag.cpp index 465c04cdc8..d7fd4d5bc0 100644 --- a/src/gui/kernel/qdrag.cpp +++ b/src/gui/kernel/qdrag.cpp @@ -101,7 +101,7 @@ QT_BEGIN_NAMESPACE \l{QWidget::mouseMoveEvent()}{mouseMoveEvent()} to check whether a QDrag is required. - \sa {Drag and Drop}, QClipboard, QMimeData, QWindowsMime, QMacPasteboardMime, + \sa {Drag and Drop}, QClipboard, QMimeData, QMacPasteboardMime, {Draggable Icons Example}, {Draggable Text Example}, {Drop Site Example}, {Fridge Magnets Example} */ diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp index 92d9871dc5..bb7000a266 100644 --- a/src/gui/kernel/qevent.cpp +++ b/src/gui/kernel/qevent.cpp @@ -628,7 +628,7 @@ QHoverEvent::~QHoverEvent() \a modifiers holds the keyboard modifier flags at the time of the event, and \a orient holds the wheel's orientation. - \sa pos(), pixelDelta(), angleDelta(), state() + \sa pos(), pixelDelta(), angleDelta() */ #ifndef QT_NO_WHEELEVENT QWheelEvent::QWheelEvent(const QPointF &pos, int delta, @@ -659,7 +659,7 @@ QWheelEvent::~QWheelEvent() \a orient holds the wheel's orientation. - \sa pos(), pixelDelta(), angleDelta(), state() + \sa pos(), pixelDelta(), angleDelta() */ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, int delta, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, diff --git a/src/gui/kernel/qopenglcontext.cpp b/src/gui/kernel/qopenglcontext.cpp index 5087e33b47..e258218e85 100644 --- a/src/gui/kernel/qopenglcontext.cpp +++ b/src/gui/kernel/qopenglcontext.cpp @@ -165,7 +165,7 @@ void QOpenGLVersionProfile::setVersion(int majorVersion, int minorVersion) /*! Returns the OpenGL profile. Only makes sense if profiles are supported by this version. - \sa setProfile(), supportsProfiles() + \sa setProfile() */ QSurfaceFormat::OpenGLContextProfile QOpenGLVersionProfile::profile() const { @@ -176,7 +176,7 @@ QSurfaceFormat::OpenGLContextProfile QOpenGLVersionProfile::profile() const Sets the OpenGL profile \a profile. Only makes sense if profiles are supported by this version. - \sa profile(), supportsProfiles() + \sa profile() */ void QOpenGLVersionProfile::setProfile(QSurfaceFormat::OpenGLContextProfile profile) { diff --git a/src/gui/kernel/qsessionmanager.cpp b/src/gui/kernel/qsessionmanager.cpp index b9ef35854c..a428840ca8 100644 --- a/src/gui/kernel/qsessionmanager.cpp +++ b/src/gui/kernel/qsessionmanager.cpp @@ -201,7 +201,7 @@ QString QSessionManager::sessionKey() const Here's an example of how an application's QGuiApplication::commitDataRequest() might be implemented: - \snippet code/src_gui_kernel_qguiapplication.cpp 8 + \snippet code/src_gui_kernel_qguiapplication.cpp 1 If an error occurred within the application while saving its data, you may want to try allowsErrorInteraction() instead. @@ -293,7 +293,7 @@ QSessionManager::RestartHint QSessionManager::restartHint() const If the session manager is capable of restoring sessions it will execute \a command in order to restore the application. The command defaults to - \snippet code/src_gui_kernel_qguiapplication.cpp 9 + \snippet code/src_gui_kernel_qguiapplication.cpp 2 The \c -session option is mandatory; otherwise QGuiApplication cannot tell whether it has been restored or what the current session identifier @@ -321,7 +321,7 @@ void QSessionManager::setRestartCommand(const QStringList &command) To iterate over the list, you can use the \l foreach pseudo-keyword: - \snippet code/src_gui_kernel_qguiapplication.cpp 10 + \snippet code/src_gui_kernel_qguiapplication.cpp 3 \sa setRestartCommand(), restartHint() */ @@ -347,7 +347,7 @@ void QSessionManager::setDiscardCommand(const QStringList &command) To iterate over the list, you can use the \l foreach pseudo-keyword: - \snippet code/src_gui_kernel_qguiapplication.cpp 11 + \snippet code/src_gui_kernel_qguiapplication.cpp 4 \sa setDiscardCommand(), restartCommand(), setRestartCommand() */ diff --git a/src/gui/kernel/qsurfaceformat.cpp b/src/gui/kernel/qsurfaceformat.cpp index 23c0e59779..2b8e611dff 100644 --- a/src/gui/kernel/qsurfaceformat.cpp +++ b/src/gui/kernel/qsurfaceformat.cpp @@ -387,7 +387,7 @@ void QSurfaceFormat::setOption(QSurfaceFormat::FormatOption option, bool on) Returns true if the format option \a option is set; otherwise returns false. - \sa options(), testOption() + \sa options() */ bool QSurfaceFormat::testOption(QSurfaceFormat::FormatOption option) const { diff --git a/src/gui/opengl/qopengltexture.cpp b/src/gui/opengl/qopengltexture.cpp index 983496230d..078274eabd 100644 --- a/src/gui/opengl/qopengltexture.cpp +++ b/src/gui/opengl/qopengltexture.cpp @@ -2668,12 +2668,12 @@ void QOpenGLTexture::generateMipMaps() } /*! - Generates mipmaps for this texture object from mipmap level \baseLevel. If you are + Generates mipmaps for this texture object from mipmap level \a baseLevel. If you are using a texture target and filtering option that requires mipmaps and you have disabled automatic mipmap generation then you need to call this function or the overload to create the mipmap chain. - The generation of mipmaps to above \baseLevel is achieved by setting the mipmap + The generation of mipmaps to above \a baseLevel is achieved by setting the mipmap base level to \a baseLevel and then generating the mipmap chain. If \a resetBaseLevel is \c true, then the baseLevel of the texture will be reset to its previous value. @@ -3000,7 +3000,7 @@ void QOpenGLTexture::setBorderColor(QColor color) } /*! - Sets the color red to \a {r}, green to \a {g}, blue to \{b}, and \a {a} to the + Sets the color red to \a {r}, green to \a {g}, blue to \a {b}, and \a {a} to the alpha value. \overload */ @@ -3033,8 +3033,8 @@ void QOpenGLTexture::setBorderColor(float r, float g, float b, float a) } /*! - Sets the color red to \a {r}, green to \a {g}, blue to \a {b}, and \a the alpha - value to {a}. + Sets the color red to \a {r}, green to \a {g}, blue to \a {b}, and the alpha + value to \a {a}. \overload */ void QOpenGLTexture::setBorderColor(int r, int g, int b, int a) @@ -3068,8 +3068,8 @@ void QOpenGLTexture::setBorderColor(int r, int g, int b, int a) } /*! - Sets the color red to \a {r}, green to \a {g}, blue to \a {b}, and \a the alpha - value to {a}. + Sets the color red to \a {r}, green to \a {g}, blue to \a {b}, and the alpha + value to \a {a}. \overload */ void QOpenGLTexture::setBorderColor(uint r, uint g, uint b, uint a) diff --git a/src/opengl/qgl.cpp b/src/opengl/qgl.cpp index de1de476b8..e602a05af9 100644 --- a/src/opengl/qgl.cpp +++ b/src/opengl/qgl.cpp @@ -3227,43 +3227,6 @@ void QGLContext::moveToThread(QThread *thread) visual. On other platforms it may work differently. */ -/*! \fn int QGLContext::choosePixelFormat(void* dummyPfd, HDC pdc) - - \b{Win32 only:} This virtual function chooses a pixel format - that matches the OpenGL \l{setFormat()}{format}. - Reimplement this function in a subclass if you need a custom - context. - - \warning The \a dummyPfd pointer and \a pdc are used as a \c - PIXELFORMATDESCRIPTOR*. We use \c void to avoid using - Windows-specific types in our header files. - - \sa chooseContext() -*/ - -/*! \fn void *QGLContext::chooseVisual() - - \b{X11 only:} This virtual function tries to find a visual that - matches the format, reducing the demands if the original request - cannot be met. - - The algorithm for reducing the demands of the format is quite - simple-minded, so override this method in your subclass if your - application has spcific requirements on visual selection. - - \sa chooseContext() -*/ - -/*! \fn void *QGLContext::tryVisual(const QGLFormat& f, int bufDepth) - \internal - - \b{X11 only:} This virtual function chooses a visual that matches - the OpenGL \l{format()}{format}. Reimplement this function - in a subclass if you need a custom visual. - - \sa chooseContext() -*/ - /*! \fn void QGLContext::reset() @@ -3706,7 +3669,7 @@ QGLWidget::~QGLWidget() */ /*! - \fn QFunctionPointer QGLContext::getProcAddress() const + \fn QFunctionPointer QGLContext::getProcAddress(const QString &proc) const Returns a function pointer to the GL extension function passed in \a proc. 0 is returned if a pointer to the function could not be @@ -4046,14 +4009,6 @@ void QGLWidget::paintEvent(QPaintEvent *) /*! - \fn void QGLWidget::setMouseTracking(bool enable) - - If \a enable is true then mouse tracking is enabled; otherwise it - is disabled. -*/ - - -/*! Renders the current scene on a pixmap and returns the pixmap. You can use this method on both visible and invisible QGLWidget objects. diff --git a/src/opengl/qglfunctions.cpp b/src/opengl/qglfunctions.cpp index 450f17b171..d6d77d0568 100644 --- a/src/opengl/qglfunctions.cpp +++ b/src/opengl/qglfunctions.cpp @@ -466,7 +466,7 @@ void QGLFunctions::initializeGLFunctions(const QGLContext *context) */ /*! - \fn void QGLFunctions::glBufferData(GLenum target, qgl_GLsizeiptr size, const void* data, GLenum usage) + \fn void QGLFunctions::glBufferData(GLenum target, qopengl_GLsizeiptr size, const void* data, GLenum usage) Convenience function that calls glBufferData(\a target, \a size, \a data, \a usage). @@ -475,7 +475,7 @@ void QGLFunctions::initializeGLFunctions(const QGLContext *context) */ /*! - \fn void QGLFunctions::glBufferSubData(GLenum target, qgl_GLintptr offset, qgl_GLsizeiptr size, const void* data) + \fn void QGLFunctions::glBufferSubData(GLenum target, qopengl_GLintptr offset, qopengl_GLsizeiptr size, const void* data) Convenience function that calls glBufferSubData(\a target, \a offset, \a size, \a data). diff --git a/src/sql/kernel/qsqlquery.cpp b/src/sql/kernel/qsqlquery.cpp index 0cfc37833d..b08f6bc8ef 100644 --- a/src/sql/kernel/qsqlquery.cpp +++ b/src/sql/kernel/qsqlquery.cpp @@ -311,7 +311,7 @@ QSqlQuery& QSqlQuery::operator=(const QSqlQuery& other) /*! Returns \c true if the query is not \l{isActive()}{active}, the query is not positioned on a valid record, - there is no such field, or the field is null; otherwise \c false. + there is no such \a field, or the \a field is null; otherwise \c false. Note that for some drivers, isNull() will not return accurate information until after an attempt is made to retrieve data. |