diff options
author | Casper van Donderen <casper.vandonderen@nokia.com> | 2012-03-20 19:37:07 +0100 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-04-19 07:34:53 +0200 |
commit | 0bc02fd0d61d1e4aed9b39890d28975dff30e822 (patch) | |
tree | e967ab719c7f8df24c35b088bd48e0f5b0942148 /src/corelib/io/qdatastream.cpp | |
parent | 7f0c130be963de90d1baeb037820b17a4f298700 (diff) |
Doc: Prepare for building modular QtCore docs.
This change fixes most qdoc errors in QtCore. There are about 900 left.
The main thing this change does is moving documentation from qtcore from
/doc/src to /src/corelib/doc.
Other issues resolved are mis-use of qdoc commands.
Change-Id: I002d01edfb13575e8bf27ce91596a577a92562d1
Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
Reviewed-by: Jason McDonald <jason.mcdonald@nokia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
Diffstat (limited to 'src/corelib/io/qdatastream.cpp')
-rw-r--r-- | src/corelib/io/qdatastream.cpp | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/src/corelib/io/qdatastream.cpp b/src/corelib/io/qdatastream.cpp index 1fe2a793a6..559c5a0743 100644 --- a/src/corelib/io/qdatastream.cpp +++ b/src/corelib/io/qdatastream.cpp @@ -81,11 +81,11 @@ QT_BEGIN_NAMESPACE Example (write binary data to a stream): - \snippet doc/src/snippets/code/src_corelib_io_qdatastream.cpp 0 + \snippet code/src_corelib_io_qdatastream.cpp 0 Example (read binary data from a stream): - \snippet doc/src/snippets/code/src_corelib_io_qdatastream.cpp 1 + \snippet code/src_corelib_io_qdatastream.cpp 1 Each item written to the stream is written in a predefined binary format that varies depending on the item's type. Supported Qt @@ -119,7 +119,7 @@ QT_BEGIN_NAMESPACE compatibility, you can hardcode the version number in the application: - \snippet doc/src/snippets/code/src_corelib_io_qdatastream.cpp 2 + \snippet code/src_corelib_io_qdatastream.cpp 2 If you are producing a new binary data format, such as a file format for documents created by your application, you could use a @@ -127,11 +127,11 @@ QT_BEGIN_NAMESPACE would write a brief header containing a magic string and a version number to give yourself room for future expansion. For example: - \snippet doc/src/snippets/code/src_corelib_io_qdatastream.cpp 3 + \snippet code/src_corelib_io_qdatastream.cpp 3 Then read it in with: - \snippet doc/src/snippets/code/src_corelib_io_qdatastream.cpp 4 + \snippet code/src_corelib_io_qdatastream.cpp 4 You can select which byte order to use when serializing data. The default setting is big endian (MSB first). Changing it to little @@ -187,7 +187,7 @@ QT_BEGIN_NAMESPACE defined, check the \b {Related Non-Members} section of the class's documentation page. - \sa QTextStream QVariant + \sa QTextStream, QVariant */ /*! @@ -421,7 +421,7 @@ bool QDataStream::atEnd() const \since 4.6 - \sa FloatingPointPrecision setFloatingPointPrecision() + \sa FloatingPointPrecision, setFloatingPointPrecision() */ QDataStream::FloatingPointPrecision QDataStream::floatingPointPrecision() const { @@ -455,7 +455,7 @@ void QDataStream::setFloatingPointPrecision(QDataStream::FloatingPointPrecision /*! Returns the status of the data stream. - \sa Status setStatus() resetStatus() + \sa Status, setStatus(), resetStatus() */ QDataStream::Status QDataStream::status() const @@ -466,7 +466,7 @@ QDataStream::Status QDataStream::status() const /*! Resets the status of the data stream. - \sa Status status() setStatus() + \sa Status, status(), setStatus() */ void QDataStream::resetStatus() { @@ -479,7 +479,7 @@ void QDataStream::resetStatus() Subsequent calls to setStatus() are ignored until resetStatus() is called. - \sa Status status() resetStatus() + \sa Status, status(), resetStatus() */ void QDataStream::setStatus(Status status) { @@ -589,7 +589,7 @@ void QDataStream::setByteOrder(ByteOrder bo) The \l Version enum provides symbolic constants for the different versions of Qt. For example: - \snippet doc/src/snippets/code/src_corelib_io_qdatastream.cpp 5 + \snippet code/src_corelib_io_qdatastream.cpp 5 \sa version(), Version */ @@ -813,7 +813,7 @@ QDataStream &QDataStream::operator>>(double &f) /*! \overload - Reads the '\0'-terminated string \a s from the stream and returns + Reads the '\\0'-terminated string \a s from the stream and returns a reference to the stream. Space for the string is allocated using \c new -- the caller must @@ -1094,7 +1094,7 @@ QDataStream &QDataStream::operator<<(double f) /*! \overload - Writes the '\0'-terminated string \a s to the stream and returns a + Writes the '\\0'-terminated string \a s to the stream and returns a reference to the stream. The string is serialized using writeBytes(). |