diff options
| author | Jerome Pasion <jerome.pasion@digia.com> | 2013-10-02 16:51:05 +0200 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-08 00:46:27 +0200 |
| commit | 4533cc994484a2308297e64e99af005fb4dca065 (patch) | |
| tree | bc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/network/access/qftp.cpp | |
| parent | 50dd0232b61d8ea3fb9aab18972c6e19678656e6 (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/network/access/qftp.cpp')
| -rw-r--r-- | src/network/access/qftp.cpp | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/network/access/qftp.cpp b/src/network/access/qftp.cpp index a77e1a643c..3b0d0deeb9 100644 --- a/src/network/access/qftp.cpp +++ b/src/network/access/qftp.cpp @@ -831,8 +831,8 @@ void QFtpPI::connectToHost(const QString &host, quint16 port) are all done the finished() signal is emitted. When an error occurs, the error() signal is emitted. - If there are pending commands in the queue this functions returns false and - the \a cmds are not added to the queue; otherwise it returns true. + If there are pending commands in the queue this functions returns \c false and + the \a cmds are not added to the queue; otherwise it returns \c true. */ bool QFtpPI::sendCommands(const QStringList &cmds) { @@ -987,7 +987,7 @@ void QFtpPI::readyRead() Process a reply from the FTP server. - Returns true if the reply was processed or false if the reply has to be + Returns \c true if the reply was processed or false if the reply has to be processed at a later point. */ bool QFtpPI::processReply() @@ -1159,8 +1159,8 @@ bool QFtpPI::processReply() /* \internal - Starts next pending command. Returns false if there are no pending commands, - otherwise it returns true. + Starts next pending command. Returns \c false if there are no pending commands, + otherwise it returns \c true. */ bool QFtpPI::startNextCmd() { @@ -2164,8 +2164,8 @@ QIODevice* QFtp::currentDevice() const /*! \internal - Returns true if there are any commands scheduled that have not yet - been executed; otherwise returns false. + Returns \c true if there are any commands scheduled that have not yet + been executed; otherwise returns \c false. The command that is being executed is \e not considered as a scheduled command. |