1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix qdoc warnings

Browse Source 
qtbase/src/network/socket/qsctpsocket.cpp:506: warning: Undocumented parameter 'datagram' in QSctpSocket::writeDatagram()
qtbase/src/network/ssl/qssldiffiehellmanparameters.cpp:129: warning: Undocumented parameter 'encoding' in QSslDiffieHellmanParameters::QSslDiffieHellmanParameters()
qtbase/src/gui/opengl/qopengltextureblitter.cpp:540: warning: Undocumented parameter 'opacity' in QOpenGLTextureBlitter::setOpacity()
qtbase/src/gui/opengl/qopengltextureblitter.cpp:522: warning: Undocumented parameter 'swizzle' in QOpenGLTextureBlitter::setRedBlueSwizzle()
qtbase/src/testlib/qtestcase.qdoc:1124: warning: Cannot find 'createTouchDevice(...)' in '\fn' QTest::createTouchDevice()

Change-Id: Ie8799aa5f63a4ea6c9fe309e2a627fbe3a13b685
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
This commit is contained in:
Friedemann Kleint 2016-08-17 12:58:03 +02:00
parent 253d2e5135
commit 60a695ab5e
4 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/gui/opengl/qopengltextureblitter.cpp
View File

@ -520,8 +520,8 @@ void QOpenGLTextureBlitter::release()
} }
/*! /*!
Enables or disables swizzling for the red and blue color Sets whether swizzling is enabled for the red and blue color channels to
channels. An BGRA to RGBA conversion (occurring in the shader on \a swizzle. An BGRA to RGBA conversion (occurring in the shader on
the GPU, instead of a slow CPU-side transformation) can be useful the GPU, instead of a slow CPU-side transformation) can be useful
when the source texture contains data from a QImage with a format when the source texture contains data from a QImage with a format
like QImage::Format_ARGB32 which maps to BGRA on little endian like QImage::Format_ARGB32 which maps to BGRA on little endian
@ -538,10 +538,11 @@ void QOpenGLTextureBlitter::setRedBlueSwizzle(bool swizzle)
} }
/*! /*!
Changes the opacity. The default opacity is 1.0. Changes the opacity to \a opacity. The default opacity is 1.0.
\note the blitter does not alter the blend state. It is up to the \note the blitter does not alter the blend state. It is up to the
caller of blit() to ensure the correct blend settings are active. caller of blit() to ensure the correct blend settings are active.
*/ */
void QOpenGLTextureBlitter::setOpacity(float opacity) void QOpenGLTextureBlitter::setOpacity(float opacity)
{ {
@ -613,7 +614,7 @@ void QOpenGLTextureBlitter::blit(GLuint texture,
the source dimensions and will in most cases be set to (0, 0, the source dimensions and will in most cases be set to (0, 0,
image width, image height). image width, image height).
For unscaled output the size of \a target and \viewport should For unscaled output the size of \a target and \a viewport should
match. match.
\sa blit() \sa blit()

2
src/network/socket/qsctpsocket.cpp
View File

@ -504,7 +504,7 @@ QNetworkDatagram QSctpSocket::readDatagram()
} }
/*! /*!
Writes a datagram to the buffer of the current write channel. Writes a \a datagram to the buffer of the current write channel.
Returns true on success; otherwise returns false. Returns true on success; otherwise returns false.
\sa readDatagram(), inDatagramMode(), currentWriteChannel() \sa readDatagram(), inDatagramMode(), currentWriteChannel()

2
src/network/ssl/qssldiffiehellmanparameters.cpp
View File

@ -128,7 +128,7 @@ QSslDiffieHellmanParameters::QSslDiffieHellmanParameters(const QByteArray &encod
/*! /*!
Constructs a QSslDiffieHellmanParameters object by Constructs a QSslDiffieHellmanParameters object by
reading from \a device in either PEM or DER form. reading from \a device in either PEM or DER form as specified by \a encoding.
After construction, the isValid() method should be used After construction, the isValid() method should be used
to check whether the Diffie-Hellman parameters were valid to check whether the Diffie-Hellman parameters were valid

4
src/testlib/qtestcase.qdoc
View File

@ -1122,10 +1122,10 @@
*/ */
/*! /*!
\fn QTest::createTouchDevice() \fn QTouchDevice *QTest::createTouchDevice(QTouchDevice::DeviceType devType = QTouchDevice::TouchScreen)
\since 5.8 \since 5.8
Creates a dummy touch device for simulation of touch events. Creates a dummy touch device of type \a devType for simulation of touch events.
The touch device will be registered with the QPA window system interface, The touch device will be registered with the QPA window system interface,
and deleted automatically when the QCoreApplication is deleted. So you and deleted automatically when the QCoreApplication is deleted. So you