Commit abbafb2b authored by Leena Miettinen's avatar Leena Miettinen Committed by The Qt Project
Browse files

Doc: Fix example pages for Qt Tools


Use the \group and \ingroup commands to produce Qt 5 style
example pages. Unify the file structure for example docs.
Add example page for Qt Help and move Context Sensitive Help
example to it (from the Qt Assistant Examples page).

Change-Id: I687b18a134037588a5a536fe2353c18dfd44b1d7
Reviewed-by: default avatarJerome Pasion <jerome.pasion@digia.com>
Reviewed-by: default avatarDavid Schulz <david.schulz@digia.com>
parent ce7fb448
dev 5.10 5.11 5.12 5.12.1 5.12.10 5.12.11 5.12.12 5.12.2 5.12.3 5.12.4 5.12.5 5.12.6 5.12.7 5.12.8 5.12.9 5.13 5.13.0 5.13.1 5.13.2 5.14 5.14.0 5.14.1 5.14.2 5.15 5.15.0 5.15.1 5.15.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9 5.9.8 6.0 6.0.0 6.1 6.1.0 6.1.1 6.1.2 6.1.3 6.2 6.2.0 6.2.1 6.2.2 old/5.0 old/5.1 old/5.2 wip/cmake wip/winrt v5.15.0-alpha1 v5.14.1 v5.14.0 v5.14.0-rc2 v5.14.0-rc1 v5.14.0-beta3 v5.14.0-beta2 v5.14.0-beta1 v5.14.0-alpha1 v5.13.2 v5.13.1 v5.13.0 v5.13.0-rc3 v5.13.0-rc2 v5.13.0-rc1 v5.13.0-beta4 v5.13.0-beta3 v5.13.0-beta2 v5.13.0-beta1 v5.13.0-alpha1 v5.12.7 v5.12.6 v5.12.5 v5.12.4 v5.12.3 v5.12.2 v5.12.1 v5.12.0 v5.12.0-rc2 v5.12.0-rc1 v5.12.0-beta4 v5.12.0-beta3 v5.12.0-beta2 v5.12.0-beta1 v5.12.0-alpha1 v5.11.3 v5.11.2 v5.11.1 v5.11.0 v5.11.0-rc2 v5.11.0-rc1 v5.11.0-beta4 v5.11.0-beta3 v5.11.0-beta2 v5.11.0-beta1 v5.11.0-alpha1 v5.10.1 v5.10.0 v5.10.0-rc3 v5.10.0-rc2 v5.10.0-rc1 v5.10.0-beta4 v5.10.0-beta3 v5.10.0-beta2 v5.10.0-beta1 v5.10.0-alpha1 v5.9.9 v5.9.8 v5.9.7 v5.9.6 v5.9.5 v5.9.4 v5.9.3 v5.9.2 v5.9.1 v5.9.0 v5.9.0-rc2 v5.9.0-rc1 v5.9.0-beta4 v5.9.0-beta3 v5.9.0-beta2 v5.9.0-beta1 v5.9.0-alpha1 v5.8.0 v5.8.0-rc1 v5.8.0-beta1 v5.8.0-alpha1 v5.7.1 v5.7.0 v5.7.0-rc1 v5.7.0-beta1 v5.7.0-alpha1 v5.6.3 v5.6.2 v5.6.1 v5.6.1-1 v5.6.0 v5.6.0-rc1 v5.6.0-beta1 v5.6.0-alpha1 v5.5.1 v5.5.0 v5.5.0-rc1 v5.5.0-beta1 v5.5.0-alpha1 v5.4.2 v5.4.1 v5.4.0 v5.4.0-rc1 v5.4.0-beta1 v5.4.0-alpha1 v5.3.2 v5.3.1 v5.3.0 v5.3.0-rc1 v5.3.0-beta1 v5.3.0-alpha1 v5.2.1 v5.2.0 v5.2.0-rc1 v5.2.0-beta1 v5.2.0-alpha1 v5.1.1 v5.1.0 v5.1.0-rc2 v5.1.0-rc1 v5.1.0-beta1 v5.1.0-alpha1 v5.0.2 v5.0.1 v5.0.0 v5.0.0-rc2
No related merge requests found
Showing with 61 additions and 15 deletions
TEMPLATE = subdirs TEMPLATE = subdirs
CONFIG += ordered CONFIG += ordered
SUBDIRS += simpletextviewer SUBDIRS += simpletextviewer \
remotecontrol
/****************************************************************************
**
** Copyright (C) 2012 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$
**
****************************************************************************/
/*!
\example remotecontrol
\ingroup examples-qtassistant
\title Remote Control Example
\brief Using and controlling Qt Assistant as a help viewer.
*/
...@@ -27,10 +27,10 @@ ...@@ -27,10 +27,10 @@
/*! /*!
\example simpletextviewer \example simpletextviewer
\ingroup examples-qtassistant
\title Simple Text Viewer Example \title Simple Text Viewer Example
\brief The Simple Text Viewer example shows how to use \QA as a customized \brief Using \QA as a customized help viewer for your application.
help viewer for your application.
\image simpletextviewer-example.png \image simpletextviewer-example.png
......
...@@ -27,10 +27,10 @@ ...@@ -27,10 +27,10 @@
/*! /*!
\example arthurplugin \example arthurplugin
\ingroup examples-designer
\title Arthur Plugin \title Arthur Plugin
\brief In this example we demonstrate the abilities of Qt's painting system \brief Using the Qt painting system with \QD custom widget plugins.
in combination with \QD's custom widget plugin facilities.
\image arthurplugin-demo.png \image arthurplugin-demo.png
......
...@@ -27,10 +27,10 @@ ...@@ -27,10 +27,10 @@
/*! /*!
\example calculatorbuilder \example calculatorbuilder
\ingroup examples-designer
\title Calculator Builder Example \title Calculator Builder Example
\brief The Calculator Builder example shows how to create a user interface from \brief Creating a user interface from a \QD form at run-time.
a \QD form at run-time, using the QUiLoader class.
\image calculatorbuilder-example.png \image calculatorbuilder-example.png
......
...@@ -27,9 +27,12 @@ ...@@ -27,9 +27,12 @@
/*! /*!
\example calculatorform \example calculatorform
\ingroup examples-designer
\title Calculator Form Example \title Calculator Form Example
\brief The Calculator Form Example shows how to use a form created with \brief Using a form created with \QD in an application.
The Calculator Form Example shows how to use a form created with
\QD in an application by using the user interface information from \QD in an application by using the user interface information from
a QWidget subclass. We use \l{Using a Designer UI File in Your Application} a QWidget subclass. We use \l{Using a Designer UI File in Your Application}
{uic's auto-connection} feature to automatically connect signals {uic's auto-connection} feature to automatically connect signals
......
...@@ -27,10 +27,13 @@ ...@@ -27,10 +27,13 @@
/*! /*!
\example containerextension \example containerextension
\ingroup examples-designer
\title Container Extension Example \title Container Extension Example
\brief The Container Extension example shows how to create a custom \brief Creating a custom multi-page plugin for \QD.
multi-page plugin for Qt Designer using the
The Container Extension example shows how to create a custom multi-page
plugin for \QD using the
QDesignerContainerExtension class. QDesignerContainerExtension class.
\image containerextension-example.png \image containerextension-example.png
......
...@@ -27,9 +27,10 @@ ...@@ -27,9 +27,10 @@
/*! /*!
\example customwidgetplugin \example customwidgetplugin
\ingroup examples-designer
\title Custom Widget Plugin Example \title Custom Widget Plugin Example
\brief The Custom Widget example shows how to create a custom widget plugin for \QD. \brief Creating a custom widget plugin for Qt Designer.
\image customwidgetplugin-example.png \image customwidgetplugin-example.png
......
...@@ -27,9 +27,13 @@ ...@@ -27,9 +27,13 @@
/*! /*!
\example taskmenuextension \example taskmenuextension
\ingroup examples-designer
\title Task Menu Extension Example \title Task Menu Extension Example
\brief The Task Menu Extension example shows how to create a custom \brief Creating a custom widget plugin for \QD and providing custom task
menu entries that are associated with the plugin.
The Task Menu Extension example shows how to create a custom
widget plugin for \l {Qt Designer Manual}{\QD}, and how to to use widget plugin for \l {Qt Designer Manual}{\QD}, and how to to use
the QDesignerTaskMenuExtension class to provide custom task menu the QDesignerTaskMenuExtension class to provide custom task menu
entries associated with the plugin. entries associated with the plugin.
......
...@@ -27,11 +27,11 @@ ...@@ -27,11 +27,11 @@
/*! /*!
\example worldtimeclockbuilder \example worldtimeclockbuilder
\ingroup examples-designer
\title World Time Clock Builder Example \title World Time Clock Builder Example
\brief The World Time Clock Builder example shows how forms created with Qt \brief Creating forms with Qt Designer that contain custom widgets that can be
Designer that contain custom widgets can be dynamically generated at dynamically generated at run-time.
run-time.
\image worldtimeclockbuilder-example.png \image worldtimeclockbuilder-example.png
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment