diff options
author | Kurt Pattyn <pattyn.kurt@gmail.com> | 2013-11-01 17:35:16 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-11-01 17:46:31 +0100 |
commit | 4208e524cd0f9dab7d5047a4032e8a3e857d0795 (patch) | |
tree | d62d09ab44b18d5a89bf2ad0afcbf1e770c7469d /src/websockets/doc/src/index.qdoc | |
parent | 1fbe1dc4857836dbb38649c435760ae141d79206 (diff) | |
download | qtwebsockets-4208e524cd0f9dab7d5047a4032e8a3e857d0795.tar.gz |
Refine doc generation
Change-Id: I9da90086c63b88a5664f241da2fa9687c3882ddf
Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
Diffstat (limited to 'src/websockets/doc/src/index.qdoc')
-rw-r--r-- | src/websockets/doc/src/index.qdoc | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/src/websockets/doc/src/index.qdoc b/src/websockets/doc/src/index.qdoc new file mode 100644 index 0000000..9f221e5 --- /dev/null +++ b/src/websockets/doc/src/index.qdoc @@ -0,0 +1,57 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Kurt Pattyn <pattyn.kurt@gmail.com> +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** 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 Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtwebsockets-index.html + \since 5.2 + \title Qt WebSockets + \brief Provides an implementation of the WebSocket protocol. + + The QtWebSockets module implements the WebSocket protocol as specified in \l {http://tools.ietf.org/html/rfc6455} {RFC 6455}. + It solely depends on Qt (no external dependencies). + + + To use this module in your application, use the following include + statement: + + \code + #include <QtWebSockets/QtWebSockets> + \endcode + + To link against the module, add this line to your \l qmake \c + .pro file: + + \code + QT += websockets + \endcode + + \section1 Related information + \list + \li \l{Qt WebSockets C++ Classes}{C++ Classes} + \li \l{Qt WebSockets Examples}{Examples} + \endlist +*/ |