From 38b87cc4bb0d4dfb47d907d39906104fea60a187 Mon Sep 17 00:00:00 2001
From: Andy Shaw <andy.shaw@qt.io>
Date: Wed, 3 Oct 2018 15:55:06 +0200
Subject: [PATCH] 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>
---
 src/gui/kernel/qsurfaceformat.cpp | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/gui/kernel/qsurfaceformat.cpp b/src/gui/kernel/qsurfaceformat.cpp
index 574310f554..1a814ec21f 100644
--- 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()
 */