aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2013-11-19 11:03:31 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-11-21 11:04:02 +0100
commit77067ca74e07c34c8db49bf2c1fecaf96bbdcc02 (patch)
treebb60ebd71014537f686c0a2f53f9c11b440bf72b
parent1906da15d32340571a04d3d7e2e190bfee26f213 (diff)
Doc: Add example documentationv5.2.0-rc1v5.2.0
Adds minimal documentation for examples and ensures that Mac Extras examples are shown in Qt Creator's example list. Task-number: QTBUG-33682 Change-Id: I6ba88bc7a1b22788d19d66d7d79dd486cd5add8c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-rw-r--r--examples/macextras/embeddedqwindow/doc/src/qtmacextras-example-embeddedqwindow.qdoc37
-rw-r--r--examples/macextras/macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc36
-rw-r--r--examples/macextras/macpasteboardmime/doc/src/qtmacextras-example-macpasteboardmime.qdoc40
-rw-r--r--src/macextras/doc/qtmacextras.qdocconf3
4 files changed, 116 insertions, 0 deletions
diff --git a/examples/macextras/embeddedqwindow/doc/src/qtmacextras-example-embeddedqwindow.qdoc b/examples/macextras/embeddedqwindow/doc/src/qtmacextras-example-embeddedqwindow.qdoc
new file mode 100644
index 0000000..b4e1e37
--- /dev/null
+++ b/examples/macextras/embeddedqwindow/doc/src/qtmacextras-example-embeddedqwindow.qdoc
@@ -0,0 +1,37 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 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$
+**
+****************************************************************************/
+
+/*!
+ \title Embedded QWindow
+ \ingroup examples-qtmacextras
+ \example embeddedqwindow
+ \brief Demonstrates embedding a QWindow into an view hierarchy of a Mac
+ OS X application.
+
+ This Mac OS X-specific example shows how to create a view hierarchy
+ containing a QWindow, with handling of Qt's mouse and keyboard events.
+*/
diff --git a/examples/macextras/macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc b/examples/macextras/macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc
new file mode 100644
index 0000000..4b6c447
--- /dev/null
+++ b/examples/macextras/macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc
@@ -0,0 +1,36 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 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$
+**
+****************************************************************************/
+
+/*!
+ \title Mac Functions
+ \ingroup examples-qtmacextras
+ \example macfunctions
+ \brief Demonstrates using functions from the QtMac namespace.
+
+ This example shows how to convert an image between a QPixmap and a
+ CGImageRef using functions from the \l QtMac namespace.
+*/
diff --git a/examples/macextras/macpasteboardmime/doc/src/qtmacextras-example-macpasteboardmime.qdoc b/examples/macextras/macpasteboardmime/doc/src/qtmacextras-example-macpasteboardmime.qdoc
new file mode 100644
index 0000000..53dfb68
--- /dev/null
+++ b/examples/macextras/macpasteboardmime/doc/src/qtmacextras-example-macpasteboardmime.qdoc
@@ -0,0 +1,40 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 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$
+**
+****************************************************************************/
+
+/*!
+ \title Mac Pasteboard MIME Converter
+ \ingroup examples-qtmacextras
+ \example macpasteboardmime
+ \brief Demonstrates using QMacPasteboardMime class.
+
+ This example shows how to use QMacPasteboardMime to do conversion
+ between a MIME type and a Uniform Type Identifier (UTI) format used
+ on Mac OS X.
+
+ The example creates a widget that accepts drag & drop events, and
+ reads contents of dropped business cards in vCard format.
+*/
diff --git a/src/macextras/doc/qtmacextras.qdocconf b/src/macextras/doc/qtmacextras.qdocconf
index 1b0f4cd..e7690c5 100644
--- a/src/macextras/doc/qtmacextras.qdocconf
+++ b/src/macextras/doc/qtmacextras.qdocconf
@@ -10,6 +10,9 @@ exampledirs += ../../../examples/macextras \
examplesinstallpath = macextras
+# Add a generic 'Qt Code Sample' thumbnail in Qt Creator for all examples
+manifestmeta.thumbnail.names += "QtMacExtras/*"
+
headerdirs = ..
sourcedirs = ..
imagedirs += images