summaryrefslogtreecommitdiffstats
path: root/src/corelib/io/qprocess.cpp
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-02 16:51:05 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-08 00:46:27 +0200
commit4533cc994484a2308297e64e99af005fb4dca065 (patch)
treebc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/corelib/io/qprocess.cpp
parent50dd0232b61d8ea3fb9aab18972c6e19678656e6 (diff)
Doc: Adding mark-up to boolean default values.
Default values should have mark-up to denote that they are code. This commit changes: -"property is true" to "property is \c true". -"Returns true" to "Returns \c true". -"property is false" to "property is \c false". -"returns true" to "returns \c true". -"returns false" to "returns \c false". src/3rdparty and non-documentation instances were ignored. Task-number: QTBUG-33360 Change-Id: Ie87eaa57af947caa1230602b61c5c46292a4cf4e Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/corelib/io/qprocess.cpp')
-rw-r--r--src/corelib/io/qprocess.cpp26
1 files changed, 13 insertions, 13 deletions
diff --git a/src/corelib/io/qprocess.cpp b/src/corelib/io/qprocess.cpp
index fb86b053e9..ab2a69d054 100644
--- a/src/corelib/io/qprocess.cpp
+++ b/src/corelib/io/qprocess.cpp
@@ -249,13 +249,13 @@ QProcessEnvironment &QProcessEnvironment::operator=(const QProcessEnvironment &o
/*!
\fn bool QProcessEnvironment::operator !=(const QProcessEnvironment &other) const
- Returns true if this and the \a other QProcessEnvironment objects are different.
+ Returns \c true if this and the \a other QProcessEnvironment objects are different.
\sa operator==()
*/
/*!
- Returns true if this and the \a other QProcessEnvironment objects are equal.
+ Returns \c true if this and the \a other QProcessEnvironment objects are equal.
Two QProcessEnvironment objects are considered equal if they have the same
set of key=value pairs. The comparison of keys is done case-sensitive on
@@ -275,7 +275,7 @@ bool QProcessEnvironment::operator==(const QProcessEnvironment &other) const
}
/*!
- Returns true if this QProcessEnvironment object is empty: that is
+ Returns \c true if this QProcessEnvironment object is empty: that is
there are no key=value pairs set.
\sa clear(), systemEnvironment(), insert()
@@ -301,7 +301,7 @@ void QProcessEnvironment::clear()
}
/*!
- Returns true if the environment variable of name \a name is found in
+ Returns \c true if the environment variable of name \a name is found in
this QProcessEnvironment object.
@@ -1587,8 +1587,8 @@ void QProcess::close()
/*! \reimp
- Returns true if the process is not running, and no more data is available
- for reading; otherwise returns false.
+ Returns \c true if the process is not running, and no more data is available
+ for reading; otherwise returns \c false.
*/
bool QProcess::atEnd() const
{
@@ -1735,8 +1735,8 @@ QProcessEnvironment QProcess::processEnvironment() const
Blocks until the process has started and the started() signal has
been emitted, or until \a msecs milliseconds have passed.
- Returns true if the process was started successfully; otherwise
- returns false (if the operation timed out or if an error
+ Returns \c true if the process was started successfully; otherwise
+ returns \c false (if the operation timed out or if an error
occurred).
This function can operate without an event loop. It is
@@ -1798,7 +1798,7 @@ bool QProcess::waitForBytesWritten(int msecs)
Blocks until the process has finished and the finished() signal
has been emitted, or until \a msecs milliseconds have passed.
- Returns true if the process finished; otherwise returns false (if
+ Returns \c true if the process finished; otherwise returns \c false (if
the operation timed out, if an error occurred, or if this QProcess
is already finished).
@@ -2366,8 +2366,8 @@ int QProcess::execute(const QString &program)
/*!
Starts the program \a program with the arguments \a arguments in a
- new process, and detaches from it. Returns true on success;
- otherwise returns false. If the calling process exits, the
+ new process, and detaches from it. Returns \c true on success;
+ otherwise returns \c false. If the calling process exits, the
detached process will continue to live.
Note that arguments that contain spaces are not passed to the
@@ -2400,8 +2400,8 @@ bool QProcess::startDetached(const QString &program,
/*!
Starts the program \a program with the given \a arguments in a
- new process, and detaches from it. Returns true on success;
- otherwise returns false. If the calling process exits, the
+ new process, and detaches from it. Returns \c true on success;
+ otherwise returns \c false. If the calling process exits, the
detached process will continue to live.
\note Arguments that contain spaces are not passed to the