diff options
author | Topi Reinio <topi.reinio@digia.com> | 2013-08-08 10:29:00 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-08-08 14:38:04 +0200 |
commit | 7089fdb9377b13e2af458b7a84b8fc2df42167b0 (patch) | |
tree | 23368cf0d55f580ec3208a7b862a12f3d0b869e0 /src | |
parent | ee74a4c8b0d8563f994004395fe2b45fcdfef04e (diff) |
Doc: Create documentation for Qt Windows Extras Examples
Initial documentation for the examples
- A .qdoc file for each example (no detailed docs yet)
- A new group page 'examples-qtwinextras'
- Add examples section to module index page
- New TOC entry 'Examples' for the QCH file
- Fix example path in .qdocconf
Change-Id: I2642e31e2eea361b47118b7b560d6c71d9780743
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/winextras/doc/qtwinextras.qdocconf | 11 | ||||
-rw-r--r-- | src/winextras/doc/src/qtwinextras-examples.qdoc | 39 | ||||
-rw-r--r-- | src/winextras/doc/src/qtwinextras-index.qdoc | 6 |
3 files changed, 53 insertions, 3 deletions
diff --git a/src/winextras/doc/qtwinextras.qdocconf b/src/winextras/doc/qtwinextras.qdocconf index 6f1d0f3..2972cd5 100644 --- a/src/winextras/doc/qtwinextras.qdocconf +++ b/src/winextras/doc/qtwinextras.qdocconf @@ -5,14 +5,16 @@ description = Qt Windows Extras Reference Documentation url = http://qt-project.org/doc/qt-$QT_VER/qtwinextras version = $QT_VERSION -exampledirs += ../../../examples \ +exampledirs += ../../../examples/winextras \ snippets +examplesinstallpath = winextras + headerdirs = .. ../../imports/winextras sourcedirs = .. ../../imports/winextras imagedirs += images -depends += qtcore qtgui +depends += qtcore qtgui qtdoc qhp.projects = QtWinExtras @@ -28,11 +30,14 @@ qhp.QtWinExtras.customFilters.Qt.name = QtWinExtras $QT_VERSION qhp.QtWinExtras.customFilters.Qt.filterAttributes = qtwinextras $QT_VERSION qhp.QtWinExtras.virtualFolder = qtwinextras -qhp.QtWinExtras.subprojects = classes qmltypes +qhp.QtWinExtras.subprojects = classes examples qmltypes qhp.QtWinExtras.subprojects.classes.title = C++ Classes and Namespaces qhp.QtWinExtras.subprojects.classes.indexTitle = Qt Windows Extras C++ Classes qhp.QtWinExtras.subprojects.classes.selectors = class function namespace fake:headerfile qhp.QtWinExtras.subprojects.classes.sortPages = true +qhp.QtWinExtras.subprojects.examples.title = Examples +qhp.QtWinExtras.subprojects.examples.indexTitle = Qt Windows Extras Examples +qhp.QtWinExtras.subprojects.examples.selectors = fake:example qhp.QtWinExtras.subprojects.qmltypes.title = QML Types qhp.QtWinExtras.subprojects.qmltypes.indexTitle = Qt Windows Extras QML Types qhp.QtWinExtras.subprojects.qmltypes.selectors = fake:qmlclass diff --git a/src/winextras/doc/src/qtwinextras-examples.qdoc b/src/winextras/doc/src/qtwinextras-examples.qdoc new file mode 100644 index 0000000..2586867 --- /dev/null +++ b/src/winextras/doc/src/qtwinextras-examples.qdoc @@ -0,0 +1,39 @@ +/**************************************************************************** +** +** 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$ +** +****************************************************************************/ + +/*! + +\group examples-qtwinextras +\title Qt Windows Extras Examples +\brief Examples for the Qt Windows Extras module. +\ingroup all-examples + +Here is a list of example applications demonstrating the functionality +provided by the \l{Qt Windows Extras} module. + +\note These examples work only on \l{Qt for Windows}{Windows} operating system. +*/
\ No newline at end of file diff --git a/src/winextras/doc/src/qtwinextras-index.qdoc b/src/winextras/doc/src/qtwinextras-index.qdoc index d29f491..d086512 100644 --- a/src/winextras/doc/src/qtwinextras-index.qdoc +++ b/src/winextras/doc/src/qtwinextras-index.qdoc @@ -55,6 +55,12 @@ \li \l {Qt Windows Extras Overview} \endlist + \section1 Examples + + \list + \li \l {Qt Windows Extras Examples} + \endlist + \section1 API Reference These are links to the API reference materials. |