summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorLaszlo Agocs <laszlo.agocs@digia.com>2014-07-08 11:09:23 +0200
committerLaszlo Agocs <laszlo.agocs@digia.com>2014-07-09 19:07:16 +0200
commitc04c6417dbd08a61da4372d6a272e461d9a3ad70 (patch)
tree0d548659d9913a5875d50f5ff875c5fc393ea9b9 /src
parent0a037078213bdeddebec775328e0116986474e3d (diff)
Add missing doc file for cocoa native context
Change-Id: I11938311f648ba63bd9bee2e518c7525871cd0a3 Reviewed-by: Jørgen Lind <jorgen.lind@digia.com>
Diffstat (limited to 'src')
-rw-r--r--src/platformheaders/nativecontexts/qcocoanativecontext.qdoc58
1 files changed, 58 insertions, 0 deletions
diff --git a/src/platformheaders/nativecontexts/qcocoanativecontext.qdoc b/src/platformheaders/nativecontexts/qcocoanativecontext.qdoc
new file mode 100644
index 0000000000..96b33ce5f8
--- /dev/null
+++ b/src/platformheaders/nativecontexts/qcocoanativecontext.qdoc
@@ -0,0 +1,58 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \class QCocoaNativeContext
+ \inmodule QtPlatformHeaders
+ \since 5.4
+
+ \brief A class encapsulating a Cocoa NSOpenGLContext.
+
+ \note There is no binary compatibility guarantee for this class, meaning
+ that an application using it is only guaranteed to work with the Qt version it was
+ developed against.
+
+ \sa QOpenGLContext::setNativeHandle(), QOpenGLContext::nativeHandle()
+ */
+
+/*!
+ \fn NSOpenGLContext *QCocoaNativeContext::context() const
+
+ \return the context.
+ */
+
+/*!
+ \fn QCocoaNativeContext::QCocoaNativeContext()
+
+ Construct a new instance with no handles.
+ */
+
+/*!
+ \fn QCocoaNativeContext::QCocoaNativeContext(NSOpenGLContext *ctx)
+
+ Constructs a new instance with the provided \a ctx handle.
+ */