summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@qt.io>2017-04-07 14:41:00 +0200
committerNico Vertriest <nico.vertriest@qt.io>2017-04-18 10:37:50 +0000
commit28ea26e574a9142b6ccdb645dbf2e5fecffd1fcd (patch)
treeeebae3bf414d7b9bf2a6d61288574a1e7468fddb
parent46976eea1890a0094da421a6dc4ac1276cfccff0 (diff)
Doc: rephrase parameter description to avoid qdoc error message
Change-Id: I79d446289b4450d2fcce097cf46d2cf7b6d969da Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
-rw-r--r--src/platformheaders/windowsfunctions/qwindowswindowfunctions.qdoc8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/platformheaders/windowsfunctions/qwindowswindowfunctions.qdoc b/src/platformheaders/windowsfunctions/qwindowswindowfunctions.qdoc
index 898b1bbb29..9061690681 100644
--- a/src/platformheaders/windowsfunctions/qwindowswindowfunctions.qdoc
+++ b/src/platformheaders/windowsfunctions/qwindowswindowfunctions.qdoc
@@ -168,10 +168,10 @@
\fn bool QWindowsWindowFunctions::isTabletMode()
This is a convenience function that can be used directly instead of resolving
- the function pointer. The function can be used to query whether Windows 10
- operates in \e{Tablet Mode}. In this mode, Windows forces all application
- main windows to open in maximized state. Applications should then avoid
- resizing windows or restoring geometries to non-maximized states.
+ the function pointer. Returns true if Windows 10 operates in \e{Tablet Mode}.
+ In this mode, Windows forces all application main windows to open in maximized
+ state. Applications should then avoid resizing windows or restoring geometries
+ to non-maximized states.
\sa QWidget::showMaximized(), QWidget::saveGeometry(), QWidget::restoreGeometry()
\since 5.9