diff --git a/src/corelib/io/qfile.cpp b/src/corelib/io/qfile.cpp
index 82aee331c59df61051dc3035314f3fc13390a627..feecbd0281ac65f2f91d19b5865d51daa333afb2 100644
--- a/src/corelib/io/qfile.cpp
+++ b/src/corelib/io/qfile.cpp
@@ -167,7 +167,7 @@ QAbstractFileEngine *QFilePrivate::engine() const
disk into a 16-bit Unicode QString. By default, it assumes that
the user system's local 8-bit encoding is used (e.g., UTF-8
on most unix based operating systems; see QTextCodec::codecForLocale() for
- details). This can be changed using setCodec().
+ details). This can be changed using \l QTextStream::setCodec().
To write text, we can use operator<<(), which is overloaded to
take a QTextStream on the left and various data types (including
@@ -987,8 +987,8 @@ bool QFile::open(FILE *fh, OpenMode mode, FileHandleFlags handleFlags)
those cases, size() returns \c 0. See QIODevice::isSequential()
for more information.
- \warning For Windows CE you may not be able to call seek(), setSize(),
- fileTime(). size() returns \c 0.
+ \warning For Windows CE you may not be able to call seek(), and size()
+ returns \c 0.
\warning Since this function opens the file without specifying the file name,
you cannot use this QFile with a QFileInfo.
diff --git a/src/corelib/io/qfiledevice.cpp b/src/corelib/io/qfiledevice.cpp
index f7e58a7bed631337db141c8f097bca5e6bab0604..f9a79cdca00223d04e6bfbb998f5f424851cd85f 100644
--- a/src/corelib/io/qfiledevice.cpp
+++ b/src/corelib/io/qfiledevice.cpp
@@ -269,7 +269,7 @@ int QFileDevice::handle() const
/*!
Returns the name of the file.
- The default implementation in QFileDevice returns QString().
+ The default implementation in QFileDevice returns a null string.
*/
QString QFileDevice::fileName() const
{
diff --git a/src/corelib/io/qiodevice.cpp b/src/corelib/io/qiodevice.cpp
index 53019e1ff408812f54ff939eb015dc417beb8c08..7b0557a49725e7d8e8f3777aa895a28e0878d661 100644
--- a/src/corelib/io/qiodevice.cpp
+++ b/src/corelib/io/qiodevice.cpp
@@ -217,7 +217,7 @@ QIODevicePrivate::~QIODevicePrivate()
\li waitFor....() - Subclasses of QIODevice implement blocking
functions for device-specific operations. For example, QProcess
- has a function called waitForStarted() which suspends operation in
+ has a function called \l {QProcess::}{waitForStarted()} which suspends operation in
the calling thread until the process has started.
\endlist
@@ -730,8 +730,7 @@ qint64 QIODevice::bytesAvailable() const
return d->buffer.size();
}
-/*!
- For buffered devices, this function returns the number of bytes
+/*! For buffered devices, this function returns the number of bytes
waiting to be written. For devices with no buffer, this function
returns 0.
@@ -943,9 +942,10 @@ qint64 QIODevice::read(char *data, qint64 maxSize)
data read as a QByteArray.
This function has no way of reporting errors; returning an empty
- QByteArray() can mean either that no data was currently available
+ QByteArray can mean either that no data was currently available
for reading, or that an error occurred.
*/
+
QByteArray QIODevice::read(qint64 maxSize)
{
Q_D(QIODevice);
@@ -994,10 +994,10 @@ QByteArray QIODevice::read(qint64 maxSize)
\overload
Reads all available data from the device, and returns it as a
- QByteArray.
+ byte array.
This function has no way of reporting errors; returning an empty
- QByteArray() can mean either that no data was currently available
+ QByteArray can mean either that no data was currently available
for reading, or that an error occurred.
*/
QByteArray QIODevice::readAll()
@@ -1173,10 +1173,10 @@ qint64 QIODevice::readLine(char *data, qint64 maxSize)
\overload
Reads a line from the device, but no more than \a maxSize characters,
- and returns the result as a QByteArray.
+ and returns the result as a byte array.
This function has no way of reporting errors; returning an empty
- QByteArray() can mean either that no data was currently available
+ QByteArray can mean either that no data was currently available
for reading, or that an error occurred.
*/
QByteArray QIODevice::readLine(qint64 maxSize)
@@ -1527,7 +1527,7 @@ qint64 QIODevice::peek(char *data, qint64 maxSize)
\snippet code/src_corelib_io_qiodevice.cpp 5
This function has no way of reporting errors; returning an empty
- QByteArray() can mean either that no data was currently available
+ QByteArray can mean either that no data was currently available
for peeking, or that an error occurred.
\sa read()
diff --git a/src/corelib/io/qprocess.cpp b/src/corelib/io/qprocess.cpp
index b03e96d0f67984d72ac9895c831ba3fc4fe3deca..66036fca90c3b72a6b747864f3eb05a88d1ab6ec 100644
--- a/src/corelib/io/qprocess.cpp
+++ b/src/corelib/io/qprocess.cpp
@@ -1689,8 +1689,8 @@ void QProcess::setEnvironment(const QStringList &environment)
\deprecated
Returns the environment that QProcess will use when starting a
process, or an empty QStringList if no environment has been set
- using setEnvironment() or setEnvironmentHash(). If no environment
- has been set, the environment of the calling process will be used.
+ using setEnvironment(). If no environment has been set, the
+ environment of the calling process will be used.
\note The environment settings are ignored on Windows CE,
as there is no concept of an environment.
@@ -2016,7 +2016,7 @@ QByteArray QProcess::readAllStandardError()
\note No further splitting of the arguments is performed.
\b{Windows:} The arguments are quoted and joined into a command line
- that is compatible with the CommandLineToArgvW() Windows function.
+ that is compatible with the \c CommandLineToArgvW() Windows function.
For programs that have different command line quoting requirements,
you need to use setNativeArguments().
@@ -2320,8 +2320,8 @@ int QProcess::exitCode() const
Returns the exit status of the last process that finished.
- On Windows, if the process was terminated with TerminateProcess()
- from another application this function will still return NormalExit
+ On Windows, if the process was terminated with TerminateProcess() from
+ another application, this function will still return NormalExit
unless the exit code is less than 0.
*/
QProcess::ExitStatus QProcess::exitStatus() const
diff --git a/src/corelib/io/qtemporaryfile.cpp b/src/corelib/io/qtemporaryfile.cpp
index 3cade0ed257c7eb8fd993f633ba5dbaf9c128360..d88ffb7c840d9e65e90ef52688f8ca9b01d80713 100644
--- a/src/corelib/io/qtemporaryfile.cpp
+++ b/src/corelib/io/qtemporaryfile.cpp
@@ -700,18 +700,20 @@ void QTemporaryFile::setFileTemplate(const QString &name)
/*!
- If \a file is not already a native file then a QTemporaryFile is created
- in the tempPath() and \a file is copied into the temporary file, then a
- pointer to the temporary file is returned. If \a file is already a native
- file, a QTemporaryFile is not created, no copy is made and 0 is returned.
+ If \a file is not already a native file, then a QTemporaryFile is created
+ in QDir::tempPath(), the contents of \a file is copied into it, and a pointer
+ to the temporary file is returned. Does nothing and returns \c 0 if \a file
+ is already a native file.
For example:
+ \code
QFile f(":/resources/file.txt");
QTemporaryFile::createNativeFile(f); // Returns a pointer to a temporary file
QFile f("/users/qt/file.txt");
QTemporaryFile::createNativeFile(f); // Returns 0
+ \endcode
\sa QFileInfo::isNativePath()
*/
diff --git a/src/corelib/io/qtextstream.cpp b/src/corelib/io/qtextstream.cpp
index 288a939ab29fece48c14a77ee935ae0bc692b3f0..b67df6a4a6569c9cc88e4e01aa5f097b06c3256b 100644
--- a/src/corelib/io/qtextstream.cpp
+++ b/src/corelib/io/qtextstream.cpp
@@ -2822,7 +2822,7 @@ QTextStream &reset(QTextStream &stream)
/*!
\relates QTextStream
- Calls skipWhiteSpace() on \a stream and returns \a stream.
+ Calls \l {QTextStream::}{skipWhiteSpace()} on \a stream and returns \a stream.
\sa {QTextStream manipulators}
*/
diff --git a/src/corelib/io/qurl.cpp b/src/corelib/io/qurl.cpp
index 7018b333f2de0880c060957753b534249513e823..c109fc4d3a342cb4a816c26d539ee510bcdafb75 100644
--- a/src/corelib/io/qurl.cpp
+++ b/src/corelib/io/qurl.cpp
@@ -2315,7 +2315,7 @@ void QUrl::setHost(const QString &host, ParsingMode mode)
as DNS requests or in HTTP request headers). If that flag is not present,
this function returns the International Domain Name (IDN) in Unicode form,
according to the list of permissible top-level domains (see
- idnWhiteList()).
+ idnWhitelist()).
All other flags are ignored. Host names cannot contain control or percent
characters, so the returned value can be considered fully decoded.
@@ -2656,8 +2656,8 @@ void QUrl::setQuery(const QUrlQuery &query)
Sets the query string of the URL to an encoded version of \a
query. The contents of \a query are converted to a string
internally, each pair delimited by the character returned by
- pairDelimiter(), and the key and value are delimited by
- valueDelimiter().
+ queryPairDelimiter(), and the key and value are delimited by
+ queryValueDelimiter().
\note This method does not encode spaces (ASCII 0x20) as plus (+) signs,
like HTML forms do. If you need that kind of encoding, you must encode
@@ -2676,8 +2676,8 @@ void QUrl::setQuery(const QUrlQuery &query)
Sets the query string of the URL to the encoded version of \a
query. The contents of \a query are converted to a string
internally, each pair delimited by the character returned by
- pairDelimiter(), and the key and value are delimited by
- valueDelimiter().
+ queryPairDelimiter(), and the key and value are delimited by
+ queryValueDelimiter().
\obsolete Use QUrlQuery and setQuery().
@@ -2691,11 +2691,11 @@ void QUrl::setQuery(const QUrlQuery &query)
Inserts the pair \a key = \a value into the query string of the
URL.
- The key/value pair is encoded before it is added to the query. The
+ The key-value pair is encoded before it is added to the query. The
pair is converted into separate strings internally. The \a key and
\a value is first encoded into UTF-8 and then delimited by the
- character returned by valueDelimiter(). Each key/value pair is
- delimited by the character returned by pairDelimiter().
+ character returned by queryValueDelimiter(). Each key-value pair is
+ delimited by the character returned by queryPairDelimiter().
\note This method does not encode spaces (ASCII 0x20) as plus (+) signs,
like HTML forms do. If you need that kind of encoding, you must encode
@@ -2929,9 +2929,8 @@ QString QUrl::query(ComponentFormattingOptions options) const
The fragment is sometimes also referred to as the URL "reference".
Passing an argument of QString() (a null QString) will unset the fragment.
- Passing an argument of QString("") (an empty but not null QString)
- will set the fragment to an empty string (as if the original URL
- had a lone "#").
+ Passing an argument of QString("") (an empty but not null QString) will set the
+ fragment to an empty string (as if the original URL had a lone "#").
The \a fragment data is interpreted according to \a mode: in StrictMode,
any '%' characters must be followed by exactly two hexadecimal characters
@@ -3006,10 +3005,10 @@ QString QUrl::fragment(ComponentFormattingOptions options) const
The fragment is sometimes also referred to as the URL "reference".
- Passing an argument of QByteArray() (a null QByteArray) will unset
- the fragment. Passing an argument of QByteArray("") (an empty but
- not null QByteArray) will set the fragment to an empty string (as
- if the original URL had a lone "#").
+ Passing an argument of QByteArray() (a null QByteArray) will unset the fragment.
+ Passing an argument of QByteArray("") (an empty but not null QByteArray)
+ will set the fragment to an empty string (as if the original URL
+ had a lone "#").
\obsolete Use setFragment(), which has the same behavior of null / empty.