Doc: fix the Qt Linguist example page
authorLeena Miettinen <riitta-leena.miettinen@digia.com>
Wed, 12 Dec 2012 08:12:49 +0000 (09:12 +0100)
committerThe Qt Project <gerrit-noreply@qt-project.org>
Wed, 12 Dec 2012 09:01:26 +0000 (10:01 +0100)
Use the \group and \ingroup commands to have qdoc
list the examples. Edit the \brief contents.

Change-Id: Iae0769bd1272b03d94b9287b9fddf78df27e1f12
Reviewed-by: David Schulz <david.schulz@digia.com>
examples/linguist/doc/src/arrowpad.qdoc
examples/linguist/doc/src/hellotr.qdoc
examples/linguist/doc/src/trollprint.qdoc
src/linguist/linguist/doc/src/linguist-examples.qdoc

index dec7fd6..2b59417 100644 (file)
@@ -28,9 +28,8 @@
 /*!
     \example arrowpad
     \title Arrow Pad Example
-
-    \brief This example is a slightly more involved and introduces a key \e
-    {Qt Linguist} concept: "contexts". It also shows how to use two
+    \ingroup examples-linguist
+    \brief Understanding the Qt Linguist \e contexts concept and using two
     or more languages.
 
     \image linguist-arrowpad_en.png
index 5e34031..67ef6db 100644 (file)
 
 /*!
     \example hellotr
+    \ingroup examples-linguist
     \title Hello tr() Example
 
-    \brief This example is a small Hello World program with a Latin translation. The
-    screenshot shows the English version.
+    \brief Translating a small Hello World program to Latin.
+
+    The screenshot shows the English version.
 
     \image linguist-hellotr_en.png
 
index fe48575..9fae61a 100644 (file)
 
 /*!
     \example trollprint
+    \ingroup examples-linguist
     \title Troll Print Example
 
-    \brief Troll Print is an example application that lets the user choose
+    \brief Updating translations for later releases.
+
+    Troll Print is an example application that lets the user choose
     printer settings. It comes in two versions: English and
     Portuguese.
 
index 85824f1..8ece692 100644 (file)
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-    \group examples-linguist.html
+    \group examples-linguist
     \ingroup all-examples
     \ingroup internationalization
     \title Qt Linguist Examples
@@ -34,7 +34,9 @@
 
     Internationalization is a core feature of Qt. These examples show how to
     access translation and localization facilities at run-time.
+*/
 
+/*
     \list
     \li \l{hellotr}{Hello tr()}\raisedaster
     \li \l{arrowpad}{Arrow Pad}\raisedaster