Document QWindow's setSurfaceType and setFormat update behavior

QWindow::setSurfaceType and QWindow::setFormat do not re-create
the QPlatformWindow. Attempt to document this behavior and point
to the documentation of destroy() and create().

Change-Id: Idf7eb343d4918a45b5a701effe3263145a33790a
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
Reviewed-by: Girish Ramakrishnan <girish.1.ramakrishnan@nokia.com>

diff --git a/src/gui/kernel/qwindow.cpp b/src/gui/kernel/qwindow.cpp
index 5262b6f..c9a49bf 100644 (file)
--- a/src/gui/kernel/qwindow.cpp
+++ b/src/gui/kernel/qwindow.cpp
@@ -200,7 +200,12 @@ QWindow::~QWindow()
     Specifies whether the window is meant for raster rendering with
     QBackingStore, or OpenGL rendering with QOpenGLContext.
 
-    \sa QBackingStore, QOpenGLContext
+    The surfaceType will be used when the native surface is created
+    in the create() function. Calling this function after the native
+    surface has been created requires calling destroy() and create()
+    to release the old native surface and create a new one.
+
+    \sa QBackingStore, QOpenGLContext, create(), destroy()
 */
 void QWindow::setSurfaceType(SurfaceType surfaceType)
 {
@@ -415,6 +420,12 @@ void QWindow::setWindowModality(Qt::WindowModality modality)
 
     The format determines properties such as color depth, alpha,
     depth and stencil buffer size, etc.
+
+    The surface format will be resolved in the create() function. Calling
+    this function after create() has been called will not re-resolve the
+    surface format of the native surface.
+
+    \sa create(), destroy()
 */
 void QWindow::setFormat(const QSurfaceFormat &format)
 {