summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2016-08-17 12:58:03 +0200
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2016-08-17 13:18:26 +0000
commit60a695ab5e4e30af6107fc2926cfaf899403b645 (patch)
tree74fe5a1506ca1a323d9c7a9e9b27c97080fbf633 /src
parent253d2e5135c83730eb1872c6da87116789307d72 (diff)
Fix qdoc warnings
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>
Diffstat (limited to 'src')
-rw-r--r--src/gui/opengl/qopengltextureblitter.cpp9
-rw-r--r--src/network/socket/qsctpsocket.cpp2
-rw-r--r--src/network/ssl/qssldiffiehellmanparameters.cpp2
-rw-r--r--src/testlib/qtestcase.qdoc4
4 files changed, 9 insertions, 8 deletions
diff --git a/src/gui/opengl/qopengltextureblitter.cpp b/src/gui/opengl/qopengltextureblitter.cpp
index 2e74afcbc2..858fc0d857 100644
--- a/src/gui/opengl/qopengltextureblitter.cpp
+++ b/src/gui/opengl/qopengltextureblitter.cpp
@@ -520,8 +520,8 @@ void QOpenGLTextureBlitter::release()
}
/*!
- Enables or disables swizzling for the red and blue color
- channels. An BGRA to RGBA conversion (occurring in the shader on
+ Sets whether swizzling is enabled for the red and blue color channels to
+ \a swizzle. An BGRA to RGBA conversion (occurring in the shader on
the GPU, instead of a slow CPU-side transformation) can be useful
when the source texture contains data from a QImage with a format
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
caller of blit() to ensure the correct blend settings are active.
+
*/
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,
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.
\sa blit()
diff --git a/src/network/socket/qsctpsocket.cpp b/src/network/socket/qsctpsocket.cpp
index f65ffa765d..cb07e80299 100644
--- a/src/network/socket/qsctpsocket.cpp
+++ b/src/network/socket/qsctpsocket.cpp
@@ -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.
\sa readDatagram(), inDatagramMode(), currentWriteChannel()
diff --git a/src/network/ssl/qssldiffiehellmanparameters.cpp b/src/network/ssl/qssldiffiehellmanparameters.cpp
index e6a2fe8a2a..e75ffe4da5 100644
--- a/src/network/ssl/qssldiffiehellmanparameters.cpp
+++ b/src/network/ssl/qssldiffiehellmanparameters.cpp
@@ -128,7 +128,7 @@ QSslDiffieHellmanParameters::QSslDiffieHellmanParameters(const QByteArray &encod
/*!
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
to check whether the Diffie-Hellman parameters were valid
diff --git a/src/testlib/qtestcase.qdoc b/src/testlib/qtestcase.qdoc
index 8bf3b30ffb..bee8a0ad93 100644
--- a/src/testlib/qtestcase.qdoc
+++ b/src/testlib/qtestcase.qdoc
@@ -1122,10 +1122,10 @@
*/
/*!
- \fn QTest::createTouchDevice()
+ \fn QTouchDevice *QTest::createTouchDevice(QTouchDevice::DeviceType devType = QTouchDevice::TouchScreen)
\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,
and deleted automatically when the QCoreApplication is deleted. So you