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: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: David Schulz <david.schulz@digia.com>

30 files changed, 182 insertions, 34 deletions

diff --git a/examples/assistant/assistant.pro b/examples/assistant/assistant.pro
index fd289a670..578c7ff5b 100644
--- a/examples/assistant/assistant.pro
+++ b/examples/assistant/assistant.pro
@@ -1,4 +1,5 @@
 TEMPLATE = subdirs
 CONFIG  += ordered
 
-SUBDIRS += simpletextviewer
+SUBDIRS += simpletextviewer \
+           remotecontrol
diff --git a/examples/assistant/simpletextviewer/doc/images/simpletextviewer-example.png b/examples/assistant/doc/images/simpletextviewer-example.png
index 95d290539..95d290539 100644
--- a/examples/assistant/simpletextviewer/doc/images/simpletextviewer-example.png
+++ b/examples/assistant/doc/images/simpletextviewer-example.png
diff --git a/examples/assistant/simpletextviewer/doc/images/simpletextviewer-findfiledialog.png b/examples/assistant/doc/images/simpletextviewer-findfiledialog.png
index f6e55f099..f6e55f099 100644
--- a/examples/assistant/simpletextviewer/doc/images/simpletextviewer-findfiledialog.png
+++ b/examples/assistant/doc/images/simpletextviewer-findfiledialog.png
diff --git a/examples/assistant/simpletextviewer/doc/images/simpletextviewer-mainwindow.png b/examples/assistant/doc/images/simpletextviewer-mainwindow.png
index 98c1c61cc..98c1c61cc 100644
--- a/examples/assistant/simpletextviewer/doc/images/simpletextviewer-mainwindow.png
+++ b/examples/assistant/doc/images/simpletextviewer-mainwindow.png
diff --git a/examples/assistant/doc/src/remotecontrol.qdoc b/examples/assistant/doc/src/remotecontrol.qdoc
new file mode 100644
index 000000000..5a8106fdb
--- /dev/null
+++ b/examples/assistant/doc/src/remotecontrol.qdoc
@@ -0,0 +1,34 @@
+/****************************************************************************
+**
+** 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.
+*/
diff --git a/examples/assistant/simpletextviewer/doc/src/simpletextviewer.qdoc b/examples/assistant/doc/src/simpletextviewer.qdoc
index 5469e0270..bf74e10ed 100644
--- a/examples/assistant/simpletextviewer/doc/src/simpletextviewer.qdoc
+++ b/examples/assistant/doc/src/simpletextviewer.qdoc
@@ -27,10 +27,10 @@
 
 /*!
     \example simpletextviewer
+    \ingroup examples-qtassistant
     \title Simple Text Viewer Example
 
-    \brief The Simple Text Viewer example shows how to use \QA as a customized
-    help viewer for your application.
+    \brief Using \QA as a customized help viewer for your application.
 
     \image simpletextviewer-example.png
 
diff --git a/examples/help/remotecontrol/enter.png b/examples/assistant/remotecontrol/enter.png
index f397f4b9c..f397f4b9c 100644
--- a/examples/help/remotecontrol/enter.png
+++ b/examples/assistant/remotecontrol/enter.png
diff --git a/examples/help/remotecontrol/main.cpp b/examples/assistant/remotecontrol/main.cpp
index a862cb2ad..a862cb2ad 100644
--- a/examples/help/remotecontrol/main.cpp
+++ b/examples/assistant/remotecontrol/main.cpp
diff --git a/examples/help/remotecontrol/remotecontrol.cpp b/examples/assistant/remotecontrol/remotecontrol.cpp
index 2569829a5..2569829a5 100644
--- a/examples/help/remotecontrol/remotecontrol.cpp
+++ b/examples/assistant/remotecontrol/remotecontrol.cpp
diff --git a/examples/help/remotecontrol/remotecontrol.h b/examples/assistant/remotecontrol/remotecontrol.h
index ecf50edcb..ecf50edcb 100644
--- a/examples/help/remotecontrol/remotecontrol.h
+++ b/examples/assistant/remotecontrol/remotecontrol.h
diff --git a/examples/help/remotecontrol/remotecontrol.pro b/examples/assistant/remotecontrol/remotecontrol.pro
index 78ce822d8..78ce822d8 100644
--- a/examples/help/remotecontrol/remotecontrol.pro
+++ b/examples/assistant/remotecontrol/remotecontrol.pro
diff --git a/examples/help/remotecontrol/remotecontrol.qrc b/examples/assistant/remotecontrol/remotecontrol.qrc
index 9b4299d21..9b4299d21 100644
--- a/examples/help/remotecontrol/remotecontrol.qrc
+++ b/examples/assistant/remotecontrol/remotecontrol.qrc
diff --git a/examples/help/remotecontrol/remotecontrol.ui b/examples/assistant/remotecontrol/remotecontrol.ui
index 1cfc7f540..1cfc7f540 100644
--- a/examples/help/remotecontrol/remotecontrol.ui
+++ b/examples/assistant/remotecontrol/remotecontrol.ui
diff --git a/examples/designer/doc/src/arthurplugin.qdoc b/examples/designer/doc/src/arthurplugin.qdoc
index 0f116e72c..9dbfaa7e8 100644
--- a/examples/designer/doc/src/arthurplugin.qdoc
+++ b/examples/designer/doc/src/arthurplugin.qdoc
@@ -27,10 +27,10 @@
 
 /*!
     \example arthurplugin
+    \ingroup examples-designer
     \title Arthur Plugin
 
-    \brief In this example we demonstrate the abilities of Qt's painting system
-    in combination with \QD's custom widget plugin facilities.
+    \brief Using the Qt painting system with \QD custom widget plugins.
 
     \image arthurplugin-demo.png
 
diff --git a/examples/designer/doc/src/calculatorbuilder.qdoc b/examples/designer/doc/src/calculatorbuilder.qdoc
index b8453544f..cb6f6f458 100644
--- a/examples/designer/doc/src/calculatorbuilder.qdoc
+++ b/examples/designer/doc/src/calculatorbuilder.qdoc
@@ -27,10 +27,10 @@
 
 /*!
     \example calculatorbuilder
+    \ingroup examples-designer
     \title Calculator Builder Example
 
-    \brief The Calculator Builder example shows how to create a user interface from
-    a \QD form at run-time, using the QUiLoader class.
+    \brief Creating a user interface from a \QD form at run-time.
 
     \image calculatorbuilder-example.png
 
diff --git a/examples/designer/doc/src/calculatorform.qdoc b/examples/designer/doc/src/calculatorform.qdoc
index 063086b3b..68e47c121 100644
--- a/examples/designer/doc/src/calculatorform.qdoc
+++ b/examples/designer/doc/src/calculatorform.qdoc
@@ -27,9 +27,12 @@
 
 /*!
     \example calculatorform
+    \ingroup examples-designer
     \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
     a QWidget subclass.  We use \l{Using a Designer UI File in Your Application}
     {uic's auto-connection} feature to automatically connect signals
diff --git a/examples/designer/doc/src/containerextension.qdoc b/examples/designer/doc/src/containerextension.qdoc
index 093993a5f..5b1b55157 100644
--- a/examples/designer/doc/src/containerextension.qdoc
+++ b/examples/designer/doc/src/containerextension.qdoc
@@ -27,10 +27,13 @@
 
 /*!
     \example containerextension
+    \ingroup examples-designer
     \title Container Extension Example
 
-    \brief The Container Extension example shows how to create a custom
-    multi-page plugin for Qt Designer using the
+    \brief Creating a custom multi-page plugin for \QD.
+
+    The Container Extension example shows how to create a custom multi-page
+    plugin for \QD using the
     QDesignerContainerExtension class.
 
     \image containerextension-example.png
diff --git a/examples/designer/doc/src/customwidgetplugin.qdoc b/examples/designer/doc/src/customwidgetplugin.qdoc
index 3206136bb..b96b3d3ce 100644
--- a/examples/designer/doc/src/customwidgetplugin.qdoc
+++ b/examples/designer/doc/src/customwidgetplugin.qdoc
@@ -27,9 +27,10 @@
 
 /*!
     \example customwidgetplugin
+    \ingroup examples-designer
     \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
 
diff --git a/examples/designer/doc/src/taskmenuextension.qdoc b/examples/designer/doc/src/taskmenuextension.qdoc
index ee80bad9f..b40e7b811 100644
--- a/examples/designer/doc/src/taskmenuextension.qdoc
+++ b/examples/designer/doc/src/taskmenuextension.qdoc
@@ -27,9 +27,13 @@
 
 /*!
     \example taskmenuextension
+    \ingroup examples-designer
     \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
     the QDesignerTaskMenuExtension class to provide custom task menu
     entries associated with the plugin.
diff --git a/examples/designer/doc/src/worldtimeclockbuilder.qdoc b/examples/designer/doc/src/worldtimeclockbuilder.qdoc
index 721d59e91..980c0f6b1 100644
--- a/examples/designer/doc/src/worldtimeclockbuilder.qdoc
+++ b/examples/designer/doc/src/worldtimeclockbuilder.qdoc
@@ -27,11 +27,11 @@
 
 /*!
   \example worldtimeclockbuilder
+  \ingroup examples-designer
   \title World Time Clock Builder Example
 
-  \brief The World Time Clock Builder example shows how forms created with Qt
-  Designer that contain custom widgets can be dynamically generated at
-  run-time.
+  \brief Creating forms with Qt Designer that contain custom widgets that can be
+  dynamically generated at run-time.
 
   \image worldtimeclockbuilder-example.png
 
diff --git a/examples/designer/doc/src/worldtimeclockplugin.qdoc b/examples/designer/doc/src/worldtimeclockplugin.qdoc
index 58770a4a5..4d3042be1 100644
--- a/examples/designer/doc/src/worldtimeclockplugin.qdoc
+++ b/examples/designer/doc/src/worldtimeclockplugin.qdoc
@@ -27,10 +27,10 @@
 
 /*!
     \example worldtimeclockplugin
+    \ingroup examples-designer
     \title World Time Clock Plugin Example
 
-    \brief The World Time Clock Plugin example shows how to create a custom
-    widget plugin for \QD that uses signals and slots.
+    \brief Creating a custom widget plugin for \QD that uses signals and slots.
 
     \image worldtimeclockplugin-example.png
 
diff --git a/examples/help/doc/src/contextsensitivehelp.qdoc b/examples/help/doc/src/contextsensitivehelp.qdoc
new file mode 100644
index 000000000..2e98cafb6
--- /dev/null
+++ b/examples/help/doc/src/contextsensitivehelp.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** 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 contextsensitivehelp
+    \ingroup examples-qthelp
+    \title Context-Sensitive Help Example
+
+    \brief Using the QHelpEngineCore class to implement context-sensitive help
+    for applications.
+*/
diff --git a/examples/help/help.pro b/examples/help/help.pro
index c98aad8a9..49aae931d 100644
--- a/examples/help/help.pro
+++ b/examples/help/help.pro
@@ -1,5 +1,4 @@
 TEMPLATE = subdirs
 CONFIG  += ordered
 
-SUBDIRS += contextsensitivehelp \
-           remotecontrol
+SUBDIRS += contextsensitivehelp
diff --git a/examples/uitools/doc/src/multipleinheritance.qdoc b/examples/uitools/doc/src/multipleinheritance.qdoc
index aec4da965..ca3ade2db 100644
--- a/examples/uitools/doc/src/multipleinheritance.qdoc
+++ b/examples/uitools/doc/src/multipleinheritance.qdoc
@@ -27,8 +27,11 @@
 
 /*!
     \example multipleinheritance
+    \ingroup examples-qtuitools
     \title Multiple Inheritance Example
 
+    \brief Using a form created with Qt Designer in an application.
+
     The Multiple Inheritance Example shows how to use a form created with
     Qt Designer in an application by subclassing both QWidget and the user
     interface class, which is \c{Ui::CalculatorForm}.
diff --git a/examples/uitools/doc/src/textfinder.qdoc b/examples/uitools/doc/src/textfinder.qdoc
index c05e35069..7552b08c8 100644
--- a/examples/uitools/doc/src/textfinder.qdoc
+++ b/examples/uitools/doc/src/textfinder.qdoc
@@ -27,10 +27,12 @@
 
 /*!
     \example textfinder
+    \ingroup examples-qtuitools
     \title Text Finder Example
 
-    \brief The Text Finder example demonstrates how to dynamically process forms
-    using the Qt UI Tools module. Dynamic form processing enables a form to
+    \brief Dynamically processing forms using Qt UI Tools.
+
+    Dynamic form processing enables a form to
     be processed at run-time only by changing the UI file for the project.
     The program allows the user to look up a particular word within the
     contents of a text file. This text file is included in the project's
diff --git a/src/assistant/assistant/doc/src/assistant-example.qdoc b/src/assistant/assistant/doc/src/assistant-example.qdoc
index 5cc03ef6f..f107202b3 100644
--- a/src/assistant/assistant/doc/src/assistant-example.qdoc
+++ b/src/assistant/assistant/doc/src/assistant-example.qdoc
@@ -26,21 +26,25 @@
 ****************************************************************************/
 
 /*!
-    \group examples-qtassistant.html
+    \group examples-qtassistant
     \ingroup all-examples
     \title Qt Assistant Examples
-    \brief Adding interactive help to your Qt application.
+    \brief Using Qt Assistant as a help viewer for  Qt applications.
 
-    \image assistant-examples.png HelpSystem
+    \image assistant-examples.png
 
-    Support for interactive help is provided by the Qt Assistant application.
-    Developers can take advantages of the facilities it offers to display
-    specially-prepared documentation to users of their applications.
+    Qt Assistant provides support for interactive help and enables you to
+    display customer documentation to users of your Qt applications.
 
+    The following examples illustrate how to use Qt Assistant as a help viewer
+    for applications.
+
+*/
+
+/*
     \list
     \li \l{simpletextviewer}{Simple Text Viewer}\raisedaster
-    \li \l{help/remotecontrol}{Remote Control}
-    \li \l{help/contextsensitivehelp}{Context-Sensitive Help}
+    \li \l{remotecontrol}{Remote Control}
     \endlist
 
     Examples marked with an asterisk (*) are fully documented.
diff --git a/src/assistant/help/doc/qthelp.qdocconf b/src/assistant/help/doc/qthelp.qdocconf
index c8cd0c9e1..2ac84c137 100644
--- a/src/assistant/help/doc/qthelp.qdocconf
+++ b/src/assistant/help/doc/qthelp.qdocconf
@@ -32,7 +32,7 @@ headerdirs += ..
 
 sourcedirs              = ..
 
-exampledirs             = ../../../../../examples/help \
+exampledirs             = ../../../../examples/help \
                           snippets
 
 imagedirs               = images
diff --git a/src/assistant/help/doc/src/qthelp-examples.qdoc b/src/assistant/help/doc/src/qthelp-examples.qdoc
new file mode 100644
index 000000000..d6f441e3a
--- /dev/null
+++ b/src/assistant/help/doc/src/qthelp-examples.qdoc
@@ -0,0 +1,47 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+    \group examples-qthelp
+    \ingroup all-examples
+    \title Qt Help Examples
+    \brief Adding context-sensitive help to Qt applications.
+
+    The Qt help system includes tools for generating and viewing Qt help files.
+    In addition, it provides classes for accessing help contents programatically
+    to be able to integrate online help into Qt applications.
+
+    The following example illustrates how to add context-sensitive help to
+    applications.
+
+*/
+
+/*
+    \list
+    \li \l{contextsensitivehelp}{Context-Sensitive Help}
+    \endlist
+*/
diff --git a/src/designer/src/designer/doc/src/designer-examples.qdoc b/src/designer/src/designer/doc/src/designer-examples.qdoc
index 0b649b025..1dce46e1e 100644
--- a/src/designer/src/designer/doc/src/designer-examples.qdoc
+++ b/src/designer/src/designer/doc/src/designer-examples.qdoc
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-    \group examples-designer.html
+    \group examples-designer
     \ingroup all-examples
     \title Qt Designer Examples
     \brief Using Qt Designer to build your UI.
@@ -35,6 +35,11 @@
     create and configure forms without writing code. GUIs created with
     Qt Designer can be compiled into an application or created at run-time.
 
+    The following examples illustrate how to create and use Qt Designer forms
+    and how to create Qt Designer custom widget plugins.
+*/
+
+/*
     \list
     \li \l{arthurplugin}{Arthur Plugin}
     \li \l{calculatorbuilder}{Calculator Builder}\raisedaster
diff --git a/src/designer/src/uitools/doc/src/qtuitools-examples.qdoc b/src/designer/src/uitools/doc/src/qtuitools-examples.qdoc
index 1500064c0..45044d6bb 100644
--- a/src/designer/src/uitools/doc/src/qtuitools-examples.qdoc
+++ b/src/designer/src/uitools/doc/src/qtuitools-examples.qdoc
@@ -26,18 +26,25 @@
 ****************************************************************************/
 
 /*!
-    \group examples-qtuitools.html
+    \group examples-qtuitools
     \ingroup all-examples
     \title Qt UI Tools Examples
     \brief Using Qt UI Tools to process UI forms.
 
     \image uitools-examples.png UiTools
 
+    The \l{Qt UI Tools} module provides classes to handle UI forms created with
+    Qt Designer. The forms are processed at run-time to dynamically generate
+    user interfaces.
+
+    The following examples illustrate how to use Qt UI Tools to process UI
+    forms.
+*/
+
+/*
     \list
         \li \l{Multiple Inheritance Example}\raisedaster
         \li \l{Text Finder Example}\raisedaster
-        \li \l{Calculator Builder Example}\raisedaster
-        \li \l{World Time Clock Builder Example}\raisedaster
     \endlist
 
     Examples marked with an asterisk (*) are fully documented.