Refine doc generation

Change-Id: I9da90086c63b88a5664f241da2fa9687c3882ddf
Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>

6 files changed, 173 insertions, 31 deletions

diff --git a/src/websockets/doc/qtwebsockets.qdocconfig b/src/websockets/doc/qtwebsockets.qdocconfig
new file mode 100644
index 0000000..0e57238
--- /dev/null
+++ b/src/websockets/doc/qtwebsockets.qdocconfig
@@ -0,0 +1,43 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
+
+project                                             = QtWebSockets
+description                                         = Qt WebSockets Reference Documentation
+url                                                 = http://qt-project.org/doc/qt-$QT_VER/qtwebsockets
+version                                             = $QT_VERSION
+
+examplesinstallpath                                 = websockets
+
+qhp.projects                                        = QtWebSockets
+
+qhp.QtWebSockets.file                               = qtwebsockets.qhp
+qhp.QtWebSockets.namespace                          = org.qt-project.qtwebsockets.$QT_VERSION_TAG
+qhp.QtWebSockets.virtualFolder                      = qtwebsockets
+qhp.QtWebSockets.indexTitle                         = Qt WebSockets
+qhp.QtWebSockets.indexRoot                          =
+
+qhp.QtWebSockets.filterAttributes                   = qtwebsockets $QT_VERSION qtrefdoc
+qhp.QtWebSockets.customFilters.Qt.name              = QtWebSockets $QT_VERSION
+qhp.QtWebSockets.customFilters.Qt.filterAttributes  = qtwebsockets $QT_VERSION
+
+qhp.QtWebSockets.subprojects                        = classes
+qhp.QtWebSockets.subprojects.classes.title          = C++ Classes
+qhp.QtWebSockets.subprojects.classes.indexTitle     = Qt WebSockets C++ Classes
+qhp.QtWebSockets.subprojects.classes.selectors      = class fake:headerfile
+qhp.QtWebSockets.subprojects.classes.sortPages      = true
+
+
+tagfile                                             = ../../../doc/qtwebsockets/qtwebsockets.tags
+
+depends                                             += qtcore qtnetwork qtdoc
+
+headerdirs                                          += ..
+
+sourcedirs                                          += ..
+
+exampledirs                                         += ../../../examples/ \
+snippets
+
+navigation.landingpage                              = "Qt WebSockets"
+navigation.cppclassespage                           = "Qt WebSockets C++ Classes"
+
+#imagedirs                                          += ./images
diff --git a/src/websockets/doc/qwebsockets.qdoc b/src/websockets/doc/qwebsockets.qdoc
deleted file mode 100644
index 5406870..0000000
--- a/src/websockets/doc/qwebsockets.qdoc
+++ /dev/null
@@ -1,8 +0,0 @@
-/*!
-  \module QtWebSockets
-  \title QtWebSockets module
-
-  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 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
deleted file mode 100644
index 33fde7d..0000000
--- a/src/websockets/doc/qwebsockets.qdocconfig
+++ /dev/null
@@ -1,23 +0,0 @@
-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
\ No newline at end of file
diff --git a/src/websockets/doc/snippets/src_websockets_ssl_qwebsocket.cpp b/src/websockets/doc/snippets/src_websockets_ssl_qwebsocket.cpp
new file mode 100644
index 0000000..602ae8f
--- /dev/null
+++ b/src/websockets/doc/snippets/src_websockets_ssl_qwebsocket.cpp
@@ -0,0 +1,26 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
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
+*/
diff --git a/src/websockets/doc/src/qtwebsockets-module.qdoc b/src/websockets/doc/src/qtwebsockets-module.qdoc
new file mode 100644
index 0000000..1d6c6f0
--- /dev/null
+++ b/src/websockets/doc/src/qtwebsockets-module.qdoc
@@ -0,0 +1,47 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+/*!
+    \module QtWebSockets
+    \title Qt WebSockets C++ Classes
+    \ingroup modules
+    \qtvariable websockets
+    \brief List of C++ classes that provice WebSockets communication.
+
+    To use these classes 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
+*/