Doc: Move and edit examples page
authorTopi Reinio <topi.reinio@digia.com>
Thu, 13 Mar 2014 14:22:36 +0000 (15:22 +0100)
committerThe Qt Project <gerrit-noreply@qt-project.org>
Fri, 14 Mar 2014 13:15:04 +0000 (14:15 +0100)
Changed the example page type to a group to have a standardized
table of examples. Also, a filename 'examples.html' is too
collision-prone when Qt docs are output to a single directory.

Also, moved the examples.qdoc file into /doc subdirectory to
avoid it from being copied to QT_INSTALL_EXAMPLES when packaging
the examples.

Change-Id: I87251e0fde127bdef3024907b6472b50039f0357
Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
examples/doc/examples.qdoc [moved from examples/examples.qdoc with 88% similarity]

similarity index 88%
rename from examples/examples.qdoc
rename to examples/doc/examples.qdoc
index bc1ad32..a9cc739 100644 (file)
 
 
 /*!
+    \group qtwebsockets-examples
     \title Qt WebSockets Examples
-    \page examples.html
     \brief List of Qt WebSocket examples
 
-    The examples below can be used as a guide to using the API.
-
-    \list
-    \li \l echoclient
-    \li \l echoserver
-    \li \l qmlwebsocketclient
-    \li \l simplechat
-    \li \l sslechoclient
-    \li \l sslechoserver
-    \endlist
+    The examples below can be used as a guide to using the \l{Qt WebSockets} API.
 */