summaryrefslogtreecommitdiff
path: root/examples/doc/examples.qdoc
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/doc/examples.qdoc
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/doc/examples.qdoc')
-rw-r--r--examples/doc/examples.qdoc49
1 files changed, 49 insertions, 0 deletions
diff --git a/examples/doc/examples.qdoc b/examples/doc/examples.qdoc
new file mode 100644
index 0000000..a9cc739
--- /dev/null
+++ b/examples/doc/examples.qdoc
@@ -0,0 +1,49 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtWebSockets module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+
+/*!
+ \group qtwebsockets-examples
+ \title Qt WebSockets Examples
+ \brief List of Qt WebSocket examples
+
+ The examples below can be used as a guide to using the \l{Qt WebSockets} API.
+*/