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>
This commit is contained in:
Friedemann Kleint 2014-03-24 16:20:11 +01:00 committed by The Qt Project
parent 21f1738a94
commit 3ed2ec1487
16 changed files with 55 additions and 77 deletions

View File

@ -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}
*/
/*!

View File

@ -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,

View File

@ -333,6 +333,26 @@ QT_BEGIN_NAMESPACE
\since 5.1
*/
/*!
\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)

View File

@ -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

View File

@ -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.

View File

@ -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
@ -164,6 +164,11 @@ QT_BEGIN_NAMESPACE
\sa isValid()
*/
/*!
\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,

View File

@ -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.

View File

@ -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}
*/

View File

@ -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,

View File

@ -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)
{

View File

@ -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()
*/

View File

@ -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
{

View File

@ -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)

View File

@ -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
@ -4045,14 +4008,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.

View File

@ -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).

View File

@ -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.