diff options
| author | Steven Ceuppens <steven.ceuppens@icloud.com> | 2013-09-27 14:27:27 +0200 |
|---|---|---|
| committer | Kurt Pattyn <pattyn.kurt@gmail.com> | 2013-09-28 21:17:48 +0200 |
| commit | 6e1e387174d20fb62a804b6e27438bcc5ea59f28 (patch) | |
| tree | 68d5c273ea682a244398ba8d3c7fbeb4a5f76b9b /src/websockets/doc | |
| parent | 315e4fa0764f8d7a568be2a8063cc33c9ec13518 (diff) | |
| download | qtwebsockets-6e1e387174d20fb62a804b6e27438bcc5ea59f28.tar.gz | |
Changes to integrate the websocket module as a full Qt Add-On module
- Changed project files to use Qt structure
- Moved existing sources into subdirectory, to make room for moduels
- Created a "import/qmlwebsocket" module skeleton (works, but needs to be extended)
- Modified examples to not use "include(.pri)", but use "QT += websocket"
- Added qml example skeleton (works, but no useful functionality yet)
Project can be build with:
$ qmake
$ make
$ make install
Module can be used in other projects with
QT += websockets
Change-Id: I2123026958b264670dbf8a978dee76edf5855806
Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
Diffstat (limited to 'src/websockets/doc')
| -rw-r--r-- | src/websockets/doc/qwebsockets.qdoc | 8 | ||||
| -rw-r--r-- | src/websockets/doc/qwebsockets.qdocconfig | 23 |
2 files changed, 31 insertions, 0 deletions
diff --git a/src/websockets/doc/qwebsockets.qdoc b/src/websockets/doc/qwebsockets.qdoc new file mode 100644 index 0000000..49bc0f0 --- /dev/null +++ b/src/websockets/doc/qwebsockets.qdoc @@ -0,0 +1,8 @@ +/*! + \module QWebSockets + \title QWebSockets module + + The QWebSockets module implements the WebSocket protocol as specified in \l {http://tools.ietf.org/html/rfc6455} {RFC 6455}. + It solely depends on Qt (no external depencies). + The module contains 2 main classes: QWebSocket and QWebSocketServer, with which one can create client- and server applications. + */ diff --git a/src/websockets/doc/qwebsockets.qdocconfig b/src/websockets/doc/qwebsockets.qdocconfig new file mode 100644 index 0000000..c707458 --- /dev/null +++ b/src/websockets/doc/qwebsockets.qdocconfig @@ -0,0 +1,23 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) + +project = QWebSockets +description = QWebSockets Reference Documentation + +outputdir = html + +headerdirs += .. +headers += ../qwebsocket.h \ + ../qwebsocketserver.h + +sourcedirs += .. +sources += ../qwebsocket.cpp \ + ../qwebsocketserver.cpp \ + qwebsockets.qdoc + +exampledirs += ../../examples/ \ + ../../examples/echoclient \ + ../../examples/echoserver + +#imagedirs += ./images + +depends += qtdoc qtnetwork qtcore |