src/websockets/doc/src/qtwebsockets-module.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2013 Kurt Pattyn <pattyn.kurt@gmail.com>
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the documentation of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:FDL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Free Documentation License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Free
  19 ** Documentation License version 1.3 as published by the Free Software
  20 ** Foundation and appearing in the file included in the packaging of
  21 ** this file.  Please review the following information to ensure
  22 ** the GNU Free Documentation License version 1.3 requirements
  23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
  24 ** $QT_END_LICENSE$
  25 **
  26 ****************************************************************************/
  27 /*!
  28     \module QtWebSockets
  29     \title Qt WebSockets C++ Classes
  30     \ingroup modules
  31     \qtvariable websockets
  32     \since 5.3
  33     \brief List of C++ classes that provide WebSockets communication.
  34
  35     To use these classes in your application, use the following include
  36     statement:
  37
  38     \code
  39     #include <QtWebSockets/QtWebSockets>
  40     \endcode
  41
  42     To link against the module, add this line to your \l qmake \c
  43     .pro file:
  44
  45     \code
  46     QT += websockets
  47     \endcode
  48 */
  49
  50 /*!
  51     \qmlmodule Qt.WebSockets 1.0
  52     \title Qt WebSockets QML Types
  53     \ingroup qmlmodules
  54     \brief Provides QML types for WebSockets communication.
  55
  56     \annotatedlist websockets-qml
  57
  58     The QML types are accessed by using:
  59     \code
  60     import Qt.WebSockets 1.0
  61     \endcode
  62 */