summaryrefslogtreecommitdiffstats
path: root/src/widgets/kernel
diff options
context:
space:
mode:
authorGiuseppe D'Angelo <giuseppe.dangelo@kdab.com>2015-02-07 15:08:10 +0100
committerGiuseppe D'Angelo <giuseppe.dangelo@kdab.com>2015-02-07 20:29:16 +0000
commit773e33af43001fbc6a047ee83e4729e6ba227998 (patch)
tree135586f1e730655ed99f2cf4171a029ab4ef7d92 /src/widgets/kernel
parent9aabc623129b8c261250177cd0092948c86112c0 (diff)
QOpenGLWidget/Window: improve docs for the dtor
Remove a typo and add the standard sentence about a dtor. Change-Id: Ie21ad6d2e83977705ea43fdc872d08f496a32376 Reviewed-by: Laszlo Agocs <laszlo.agocs@theqtcompany.com>
Diffstat (limited to 'src/widgets/kernel')
-rw-r--r--src/widgets/kernel/qopenglwidget.cpp4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/widgets/kernel/qopenglwidget.cpp b/src/widgets/kernel/qopenglwidget.cpp
index 3550b0d9e6..8ed2f52cbb 100644
--- a/src/widgets/kernel/qopenglwidget.cpp
+++ b/src/widgets/kernel/qopenglwidget.cpp
@@ -862,12 +862,14 @@ QOpenGLWidget::QOpenGLWidget(QWidget *parent, Qt::WindowFlags f)
}
/*!
+ Destroys the QOpenGLWidget instance, freeing its resources.
+
The QOpenGLWidget's context is made current in the destructor, allowing for
safe destruction of any child object that may need to release OpenGL
resources belonging to the context provided by this widget.
\warning if you have objects wrapping OpenGL resources (such as
- QOpenGLBuffer, QOpenGLShaderProgram, etc.), as members of a OpenGLWidget
+ QOpenGLBuffer, QOpenGLShaderProgram, etc.) as members of a OpenGLWidget
subclass, you may need to add a call to makeCurrent() in that subclass'
destructor as well. Due to the rules of C++ object destruction, those objects
will be destroyed \e{before} calling this function (but after that the