From ddbbc1f08c9e267b8d4a447e20034ba53b1a53d0 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 16 Apr 2014 12:43:47 +0200 Subject: Doc: Improved example documentation. -updated copyright year -added instruction for running the example from within Qt Creator (using \include) -added links to relevant pages -qdocconf change needed for \include Task-number: QTBUG-33597 Change-Id: I19ab712d0e74503d618c49633951d1628f822668 Reviewed-by: Sze Howe Koh --- .../doc/src/qtmacextras-example-embeddedqwindow.qdoc | 6 +++++- .../macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc | 6 +++++- .../doc/src/qtmacextras-example-macpasteboardmime.qdoc | 6 +++++- src/macextras/doc/qtmacextras.qdocconf | 4 ++-- 4 files changed, 17 insertions(+), 5 deletions(-) diff --git a/examples/macextras/embeddedqwindow/doc/src/qtmacextras-example-embeddedqwindow.qdoc b/examples/macextras/embeddedqwindow/doc/src/qtmacextras-example-embeddedqwindow.qdoc index b4e1e37..e5bab01 100644 --- a/examples/macextras/embeddedqwindow/doc/src/qtmacextras-example-embeddedqwindow.qdoc +++ b/examples/macextras/embeddedqwindow/doc/src/qtmacextras-example-embeddedqwindow.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** 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. @@ -34,4 +34,8 @@ 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. + + \include examples-run.qdocinc + + \sa {Qt for Mac OS X}, {Qt Mac Extras} */ diff --git a/examples/macextras/macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc b/examples/macextras/macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc index 4b6c447..bcd6f40 100644 --- a/examples/macextras/macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc +++ b/examples/macextras/macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** 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. @@ -33,4 +33,8 @@ This example shows how to convert an image between a QPixmap and a CGImageRef using functions from the \l QtMac namespace. + + \include examples-run.qdocinc + + \sa {Qt for Mac OS X}, {Qt Mac Extras} */ diff --git a/examples/macextras/macpasteboardmime/doc/src/qtmacextras-example-macpasteboardmime.qdoc b/examples/macextras/macpasteboardmime/doc/src/qtmacextras-example-macpasteboardmime.qdoc index 53dfb68..df99169 100644 --- a/examples/macextras/macpasteboardmime/doc/src/qtmacextras-example-macpasteboardmime.qdoc +++ b/examples/macextras/macpasteboardmime/doc/src/qtmacextras-example-macpasteboardmime.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** 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. @@ -37,4 +37,8 @@ The example creates a widget that accepts drag & drop events, and reads contents of dropped business cards in vCard format. + + \include examples-run.qdocinc + + \sa {Qt for Mac OS X}, {Qt Mac Extras} */ diff --git a/src/macextras/doc/qtmacextras.qdocconf b/src/macextras/doc/qtmacextras.qdocconf index e7690c5..0c7aaf9 100644 --- a/src/macextras/doc/qtmacextras.qdocconf +++ b/src/macextras/doc/qtmacextras.qdocconf @@ -13,8 +13,8 @@ examplesinstallpath = macextras # Add a generic 'Qt Code Sample' thumbnail in Qt Creator for all examples manifestmeta.thumbnail.names += "QtMacExtras/*" -headerdirs = .. -sourcedirs = .. +headerdirs += .. +sourcedirs += .. imagedirs += images Cpp.ignoretokens += Q_MACEXTRAS_EXPORT -- cgit v1.2.3