diff options
author | Kurt Pattyn <pattyn.kurt@gmail.com> | 2013-12-22 17:15:51 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-12-22 17:16:48 +0100 |
commit | c481daa1899ebffe6d7d3805fd503aa8d29ad715 (patch) | |
tree | 13202ffde3aa220d0a9eec7f704494cae3e37d80 /examples/examples.qdoc | |
parent | 83caeb8ca705e95330f14f8795ffd0bf84cc3a9b (diff) | |
download | qtwebsockets-c481daa1899ebffe6d7d3805fd503aa8d29ad715.tar.gz |
Add extra documentation
Change-Id: I1a3c0571faeabf2d05bc144628d186e5ff039014
Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
Diffstat (limited to 'examples/examples.qdoc')
-rw-r--r-- | examples/examples.qdoc | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/examples/examples.qdoc b/examples/examples.qdoc new file mode 100644 index 0000000..b770704 --- /dev/null +++ b/examples/examples.qdoc @@ -0,0 +1,59 @@ +/**************************************************************************** +** +** 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$ +** +****************************************************************************/ + + +/*! + \title Qt WebSockets Examples + \page examples.html + \brief List of Qt WebSocket examples + + The module provides the following examples for reference to + help understand the API usage: + + \list + \li \l echoclient + \li \l echoserver + \li \l qmlwebsocketclient + \li \l simplechat + \li \l sslechoclient + \li \l sslechoserver + \endlist +*/ |