diff options
| author | Kurt Pattyn <pattyn.kurt@gmail.com> | 2014-03-09 12:33:26 +0100 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-03-11 13:17:56 +0100 |
| commit | ceac1d619029e1fcf10c12290fbaac25c7fa516e (patch) | |
| tree | 11189e86316c045404fe61558b0b19bfa1bef3c6 | |
| parent | f24940a3692dc9e37f519e0c1af47033b2361306 (diff) | |
| download | qtwebsockets-ceac1d619029e1fcf10c12290fbaac25c7fa516e.tar.gz | |
Fix documentation warnings
Change-Id: I5790460aab2377144d041c5b2a75ae0208ec5c00
Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
| -rw-r--r-- | src/websockets/qmaskgenerator.cpp | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/src/websockets/qmaskgenerator.cpp b/src/websockets/qmaskgenerator.cpp index aa78f77..3e4ce17 100644 --- a/src/websockets/qmaskgenerator.cpp +++ b/src/websockets/qmaskgenerator.cpp @@ -41,7 +41,9 @@ /*! \class QMaskGenerator - The QMaskGenerator class provides an abstract base for custom 32-bit mask generators. + \inmodule QtWebSockets + + \brief The QMaskGenerator class provides an abstract base for custom 32-bit mask generators. The WebSockets specification as outlined in {http://tools.ietf.org/html/rfc6455}{RFC 6455} requires that all communication from client to server must be masked. This is to prevent @@ -61,6 +63,7 @@ Initializes the QMaskGenerator by seeding the randomizer. When seed() is not called, it depends on the specific implementation of a subclass if a default seed is used or no seed is used at all. + Returns \e true if seeding succeeds, otherwise false. */ /*! @@ -75,7 +78,7 @@ QT_BEGIN_NAMESPACE /*! - Creates a new QMaskGenerator object. + Creates a new QMaskGenerator object with the given optional QObject \a parent. */ QMaskGenerator::QMaskGenerator(QObject *parent) : QObject(parent) |