From: Topi Reinio <topi.reinio@digia.com>
Date: Thu, 13 Mar 2014 14:22:36 +0000 (+0100)
Subject: Doc: Move and edit examples page
X-Git-Tag: v5.3.0-beta1~7
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;ds=sidebyside;h=ccc645054c961d965892b873a9a8137cedcb27fe;p=contrib%2Fqtwebsockets.git

Doc: Move and edit examples page

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>
---

diff --git a/examples/examples.qdoc b/examples/doc/examples.qdoc
similarity index 88%
rename from examples/examples.qdoc
rename to examples/doc/examples.qdoc
index bc1ad32..a9cc739 100644
--- a/examples/examples.qdoc
+++ b/examples/doc/examples.qdoc
@@ -41,18 +41,9 @@
 
 
 /*!
+    \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.
 */