Add \brief description to tools examples.
authorhjk <qthjk@ovi.com>
Wed, 5 Dec 2012 11:48:16 +0000 (12:48 +0100)
committerThe Qt Project <gerrit-noreply@qt-project.org>
Wed, 5 Dec 2012 12:05:13 +0000 (13:05 +0100)
Change-Id: I713620c8c5cf55147b1c5732d745569916a8e264
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
13 files changed:
examples/designer/doc/src/arthurplugin.qdoc
examples/designer/doc/src/calculatorbuilder.qdoc
examples/designer/doc/src/calculatorform.qdoc
examples/designer/doc/src/containerextension.qdoc
examples/designer/doc/src/customwidgetplugin.qdoc
examples/designer/doc/src/taskmenuextension.qdoc
examples/designer/doc/src/worldtimeclockbuilder.qdoc
examples/designer/doc/src/worldtimeclockplugin.qdoc
examples/help/simpletextviewer/doc/src/simpletextviewer.qdoc
examples/linguist/doc/src/arrowpad.qdoc
examples/linguist/doc/src/hellotr.qdoc
examples/linguist/doc/src/trollprint.qdoc
src/designer/src/lib/uilib/container.qdoc

index dedbd60..5007e9c 100644 (file)
@@ -29,7 +29,7 @@
     \example designer/arthurplugin
     \title Arthur Plugin
 
-    In this example we demonstrate the abilities of Qt's painting system
+    \brief In this example we demonstrate the abilities of Qt's painting system
     in combination with \QD's custom widget plugin facilities.
 
     \image arthurplugin-demo.png
index ce62acc..4db5da3 100644 (file)
@@ -29,7 +29,7 @@
     \example designer/calculatorbuilder
     \title Calculator Builder Example
 
-    The Calculator Builder example shows how to create a user interface from
+    \brief The Calculator Builder example shows how to create a user interface from
     a \QD form at run-time, using the QUiLoader class.
 
     \image calculatorbuilder-example.png
index 2fb033c..b03cc7f 100644 (file)
@@ -29,7 +29,7 @@
     \example designer/calculatorform
     \title Calculator Form Example
 
-    The Calculator Form Example shows how to use a form created with
+    \brief 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
index 4836db1..cce69ed 100644 (file)
@@ -29,7 +29,7 @@
     \example designer/containerextension
     \title Container Extension Example
 
-    The Container Extension example shows how to create a custom
+    \brief The Container Extension example shows how to create a custom
     multi-page plugin for Qt Designer using the
     QDesignerContainerExtension class.
 
index 5176556..bd1e76d 100644 (file)
@@ -29,7 +29,7 @@
     \example designer/customwidgetplugin
     \title Custom Widget Plugin Example
 
-    The Custom Widget example shows how to create a custom widget plugin for \QD.
+    \brief The Custom Widget example shows how to create a custom widget plugin for \QD.
 
     \image customwidgetplugin-example.png
 
index f428873..35f2970 100644 (file)
@@ -29,7 +29,7 @@
     \example designer/taskmenuextension
     \title Task Menu Extension Example
 
-    The Task Menu Extension example shows how to create a custom
+    \brief 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.
index 1f2f055..2c0445d 100644 (file)
@@ -29,7 +29,7 @@
   \example designer/worldtimeclockbuilder
   \title World Time Clock Builder Example
 
-  The World Time Clock Builder example shows how forms created with Qt
+  \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.
 
index 57ce8d9..8bcb6ce 100644 (file)
@@ -29,7 +29,7 @@
     \example designer/worldtimeclockplugin
     \title World Time Clock Plugin Example
 
-    The World Time Clock Plugin example shows how to create a custom
+    \brief The World Time Clock Plugin example shows how to create a custom
     widget plugin for \QD that uses signals and slots.
 
     \image worldtimeclockplugin-example.png
index 63ea51a..dd89047 100644 (file)
     \example help/simpletextviewer
     \title Simple Text Viewer Example
 
-    The Simple Text Viewer example shows how to use \QA as a customized
+    \brief The Simple Text Viewer example shows how to use \QA as a customized
     help viewer for your application.
 
+    \image simpletextviewer-example.png
+
     This is done in two stages. Firstly, documentation is created and \QA
     is customized; secondly, the functionality to launch and control
     \QA is added to the application.
 
-    \image simpletextviewer-example.png
-
     The Simple Text Viewer application lets the user select and view
     existing files.
 
index 6e0ae5d..dec7fd6 100644 (file)
@@ -29,7 +29,7 @@
     \example arrowpad
     \title Arrow Pad Example
 
-    This example is a slightly more involved and introduces a key \e
+    \brief This example is a slightly more involved and introduces a key \e
     {Qt Linguist} concept: "contexts". It also shows how to use two
     or more languages.
 
index 023e41b..5e34031 100644 (file)
@@ -29,8 +29,8 @@
     \example hellotr
     \title Hello tr() Example
 
-    This example is a small Hello World program with a Latin translation. The
-    screenshot below shows the English version.
+    \brief This example is a small Hello World program with a Latin translation. The
+    screenshot shows the English version.
 
     \image linguist-hellotr_en.png
 
index f6fbc5e..fe48575 100644 (file)
@@ -29,7 +29,7 @@
     \example trollprint
     \title Troll Print Example
 
-    Troll Print is an example application that lets the user choose
+    \brief Troll Print is an example application that lets the user choose
     printer settings. It comes in two versions: English and
     Portuguese.
 
index 42a8320..95ef518 100644 (file)
     a custom multi-page container in Qt Designer's workspace.
     \inmodule QtDesigner
 
+    \image containerextension-example.png
+
     QDesignerContainerExtension provide an interface for creating
     custom container extensions. A container extension consists of a
     collection of functions that \QD needs to manage a multi-page
     container plugin, and a list of the container's pages.
 
-    \image containerextension-example.png
-
     \warning This is \e not an extension for container plugins in
     general, only custom \e multi-page containers.