summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2014-03-13 15:22:36 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-14 14:15:04 +0100
commitccc645054c961d965892b873a9a8137cedcb27fe (patch)
tree9c19fe315f395cf8850c42f10542e25ab9c8a41b /examples
parentd4ac9f51f6d18a05016e3d61c06eace27501f589 (diff)
downloadqtwebsockets-ccc645054c961d965892b873a9a8137cedcb27fe.tar.gz
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>
Diffstat (limited to 'examples')
-rw-r--r--examples/doc/examples.qdoc (renamed from examples/examples.qdoc)13
1 files changed, 2 insertions, 11 deletions
diff --git a/examples/examples.qdoc b/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.
*/