Doc: Clarify what samples() returns if not explicitly set

Change-Id: Icf4478121a9d67356eb976039c666d6945a2099c Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
2018-10-03 15:55:06 +02:00 · 2018-10-03 15:55:06 +02:00 · 38b87cc4bb
parent 9933511838
commit 38b87cc4bb
1 changed files with 2 additions and 1 deletions
--- a/src/gui/kernel/qsurfaceformat.cpp
+++ b/src/gui/kernel/qsurfaceformat.cpp
@ -319,7 +319,8 @@ void QSurfaceFormat::setStereo(bool enable)

 /*!
    Returns the number of samples per pixel when multisampling is
-    enabled. By default, multisampling is disabled.
+    enabled, or \c -1 when multisampling is disabled. The default
+    return value is \c -1.

    \sa setSamples()
 */