diff options
Diffstat (limited to 'src/jsonstream/doc/src/jsonstreamnamespace.qdoc')
| -rw-r--r-- | src/jsonstream/doc/src/jsonstreamnamespace.qdoc | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/src/jsonstream/doc/src/jsonstreamnamespace.qdoc b/src/jsonstream/doc/src/jsonstreamnamespace.qdoc new file mode 100644 index 0000000..4051115 --- /dev/null +++ b/src/jsonstream/doc/src/jsonstreamnamespace.qdoc @@ -0,0 +1,72 @@ +/**************************************************************************** +** +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtAddOn.JsonStream module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** GNU Lesser General Public License Usage +** This file may be used under the terms of the GNU Lesser General Public +** License version 2.1 as published by the Free Software Foundation and +** appearing in the file LICENSE.LGPL included in the packaging of this +** file. Please review the following information to ensure the GNU Lesser +** General Public License version 2.1 requirements will be met: +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +\*! + \namespace QtJsonStream + \brief The QtJsonStream namespace contains miscellaneous identifiers + used throughout the JsonStream library. +*/ + +/*! + \headerfile <qjsonstream-global.h> + \title Global QtJsonStream declarations + + \brief The <qjsonstream-global.h> file provides namespace + declarations and global enumerations for QtJsonStream. + */ + +/*! + \relates <qjsonstream-global.h> + \enum EncodingFormat + + This enum is used to control the serialization format of the data stream. + All data streams start as \c QJsonStream::FormatUndefined. Once a data message is received, + the stream automatically switches to the format of the received message. + + \value FormatUndefined No messages have been sent or received yet. + \value FormatUTF8 UTF-8 + \value FormatBSON BSON binary format + \value FormatQBJS Qt Binary Json + \value FormatUTF16BE UTF-16, Big Endian + \value FormatUTF16LE UTF-16, Little Endian + \value FormatUTF32BE UTF-32, Big Endian + \value FormatUTF32LE UTF-32, Little Endian +*/ |