summaryrefslogtreecommitdiffstats
path: root/src/network/ssl
diff options
context:
space:
mode:
Diffstat (limited to 'src/network/ssl')
-rw-r--r--src/network/ssl/qsslcertificate.cpp16
-rw-r--r--src/network/ssl/qsslcertificateextension.cpp2
-rw-r--r--src/network/ssl/qsslcipher.cpp6
-rw-r--r--src/network/ssl/qsslconfiguration.cpp8
-rw-r--r--src/network/ssl/qsslerror.cpp4
-rw-r--r--src/network/ssl/qsslkey.cpp8
-rw-r--r--src/network/ssl/qsslsocket.cpp22
7 files changed, 33 insertions, 33 deletions
diff --git a/src/network/ssl/qsslcertificate.cpp b/src/network/ssl/qsslcertificate.cpp
index 8b5be7ae00..286a6fd668 100644
--- a/src/network/ssl/qsslcertificate.cpp
+++ b/src/network/ssl/qsslcertificate.cpp
@@ -200,8 +200,8 @@ QSslCertificate &QSslCertificate::operator=(const QSslCertificate &other)
*/
/*!
- Returns true if this certificate is the same as \a other; otherwise
- returns false.
+ Returns \c true if this certificate is the same as \a other; otherwise
+ returns \c false.
*/
bool QSslCertificate::operator==(const QSslCertificate &other) const
{
@@ -217,13 +217,13 @@ bool QSslCertificate::operator==(const QSslCertificate &other) const
/*!
\fn bool QSslCertificate::operator!=(const QSslCertificate &other) const
- Returns true if this certificate is not the same as \a other; otherwise
- returns false.
+ Returns \c true if this certificate is not the same as \a other; otherwise
+ returns \c false.
*/
/*!
- Returns true if this is a null certificate (i.e., a certificate
- with no contents); otherwise returns false.
+ Returns \c true if this is a null certificate (i.e., a certificate
+ with no contents); otherwise returns \c false.
By default, QSslCertificate constructs a null certificate.
@@ -254,8 +254,8 @@ bool QSslCertificate::isNull() const
#endif
/*!
- Returns true if this certificate is blacklisted; otherwise
- returns false.
+ Returns \c true if this certificate is blacklisted; otherwise
+ returns \c false.
\sa isNull()
*/
diff --git a/src/network/ssl/qsslcertificateextension.cpp b/src/network/ssl/qsslcertificateextension.cpp
index 0bca558c87..c059d12221 100644
--- a/src/network/ssl/qsslcertificateextension.cpp
+++ b/src/network/ssl/qsslcertificateextension.cpp
@@ -83,7 +83,7 @@
Whilst this class provides access to any type of extension, only
some are guaranteed to be returned in a format that will remain
- unchanged between releases. The isSupported() method returns true
+ unchanged between releases. The isSupported() method returns \c true
for extensions where this is the case.
The extensions currently supported, and the structure of the value
diff --git a/src/network/ssl/qsslcipher.cpp b/src/network/ssl/qsslcipher.cpp
index b045d2eba9..cdb0ed9063 100644
--- a/src/network/ssl/qsslcipher.cpp
+++ b/src/network/ssl/qsslcipher.cpp
@@ -133,7 +133,7 @@ QSslCipher &QSslCipher::operator=(const QSslCipher &other)
*/
/*!
- Returns true if this cipher is the same as \a other; otherwise,
+ Returns \c true if this cipher is the same as \a other; otherwise,
false is returned.
*/
bool QSslCipher::operator==(const QSslCipher &other) const
@@ -144,12 +144,12 @@ bool QSslCipher::operator==(const QSslCipher &other) const
/*!
\fn bool QSslCipher::operator!=(const QSslCipher &other) const
- Returns true if this cipher is not the same as \a other;
+ Returns \c true if this cipher is not the same as \a other;
otherwise, false is returned.
*/
/*!
- Returns true if this is a null cipher; otherwise returns false.
+ Returns \c true if this is a null cipher; otherwise returns \c false.
*/
bool QSslCipher::isNull() const
{
diff --git a/src/network/ssl/qsslconfiguration.cpp b/src/network/ssl/qsslconfiguration.cpp
index 6cc06dfbd2..8979c48d5d 100644
--- a/src/network/ssl/qsslconfiguration.cpp
+++ b/src/network/ssl/qsslconfiguration.cpp
@@ -160,7 +160,7 @@ QSslConfiguration &QSslConfiguration::operator=(const QSslConfiguration &other)
*/
/*!
- Returns true if this QSslConfiguration object is equal to \a
+ Returns \c true if this QSslConfiguration object is equal to \a
other.
Two QSslConfiguration objects are considered equal if they have
@@ -191,7 +191,7 @@ bool QSslConfiguration::operator==(const QSslConfiguration &other) const
/*!
\fn QSslConfiguration::operator!=(const QSslConfiguration &other) const
- Returns true if this QSslConfiguration differs from \a other. Two
+ Returns \c true if this QSslConfiguration differs from \a other. Two
QSslConfiguration objects are considered different if any state or
setting is different.
@@ -199,7 +199,7 @@ bool QSslConfiguration::operator==(const QSslConfiguration &other) const
*/
/*!
- Returns true if this is a null QSslConfiguration object.
+ Returns \c true if this is a null QSslConfiguration object.
A QSslConfiguration object is null if it has been
default-constructed and no setter methods have been called.
@@ -589,7 +589,7 @@ void QSslConfiguration::setSslOption(QSsl::SslOption option, bool on)
/*!
\since 4.8
- Returns true if the specified SSL compatibility \a option is enabled.
+ Returns \c true if the specified SSL compatibility \a option is enabled.
\sa setSslOption()
*/
diff --git a/src/network/ssl/qsslerror.cpp b/src/network/ssl/qsslerror.cpp
index bf75d2e610..07ce66bcbc 100644
--- a/src/network/ssl/qsslerror.cpp
+++ b/src/network/ssl/qsslerror.cpp
@@ -184,7 +184,7 @@ QSslError &QSslError::operator=(const QSslError &other)
/*!
\since 4.4
- Returns true if this error is equal to \a other; otherwise returns false.
+ Returns \c true if this error is equal to \a other; otherwise returns \c false.
*/
bool QSslError::operator==(const QSslError &other) const
{
@@ -196,7 +196,7 @@ bool QSslError::operator==(const QSslError &other) const
\fn bool QSslError::operator!=(const QSslError &other) const
\since 4.4
- Returns true if this error is not equal to \a other; otherwise returns
+ Returns \c true if this error is not equal to \a other; otherwise returns
false.
*/
diff --git a/src/network/ssl/qsslkey.cpp b/src/network/ssl/qsslkey.cpp
index f86466d8ed..cf62f44855 100644
--- a/src/network/ssl/qsslkey.cpp
+++ b/src/network/ssl/qsslkey.cpp
@@ -322,7 +322,7 @@ QSslKey &QSslKey::operator=(const QSslKey &other)
*/
/*!
- Returns true if this is a null key; otherwise false.
+ Returns \c true if this is a null key; otherwise false.
\sa clear()
*/
@@ -463,7 +463,7 @@ Qt::HANDLE QSslKey::handle() const
}
/*!
- Returns true if this key is equal to \a other; otherwise returns false.
+ Returns \c true if this key is equal to \a other; otherwise returns \c false.
*/
bool QSslKey::operator==(const QSslKey &other) const
{
@@ -484,8 +484,8 @@ bool QSslKey::operator==(const QSslKey &other) const
/*! \fn bool QSslKey::operator!=(const QSslKey &other) const
- Returns true if this key is not equal to key \a other; otherwise
- returns false.
+ Returns \c true if this key is not equal to key \a other; otherwise
+ returns \c false.
*/
#ifndef QT_NO_DEBUG_STREAM
diff --git a/src/network/ssl/qsslsocket.cpp b/src/network/ssl/qsslsocket.cpp
index 14063812c4..24843e9f92 100644
--- a/src/network/ssl/qsslsocket.cpp
+++ b/src/network/ssl/qsslsocket.cpp
@@ -464,8 +464,8 @@ void QSslSocket::connectToHostEncrypted(const QString &hostName, quint16 port,
/*!
Initializes QSslSocket with the native socket descriptor \a
- socketDescriptor. Returns true if \a socketDescriptor is accepted
- as a valid socket descriptor; otherwise returns false.
+ socketDescriptor. Returns \c true if \a socketDescriptor is accepted
+ as a valid socket descriptor; otherwise returns \c false.
The socket is opened in the mode specified by \a openMode, and
enters the socket state specified by \a state.
@@ -541,7 +541,7 @@ QSslSocket::SslMode QSslSocket::mode() const
}
/*!
- Returns true if the socket is encrypted; otherwise, false is returned.
+ Returns \c true if the socket is encrypted; otherwise, false is returned.
An encrypted socket encrypts all data that is written by calling write()
or putChar() before the data is written to the network, and decrypts all
@@ -756,7 +756,7 @@ qint64 QSslSocket::encryptedBytesToWrite() const
/*!
\reimp
- Returns true if you can read one while line (terminated by a single ASCII
+ Returns \c true if you can read one while line (terminated by a single ASCII
'\\n' character) of decrypted characters; otherwise, false is returned.
*/
bool QSslSocket::canReadLine() const
@@ -799,7 +799,7 @@ bool QSslSocket::atEnd() const
/*!
This function writes as much as possible from the internal write buffer to
the underlying network socket, without blocking. If any data was written,
- this function returns true; otherwise false is returned.
+ this function returns \c true; otherwise false is returned.
Call this function if you need QSslSocket to start sending buffered data
immediately. The number of bytes successfully written depends on the
@@ -1255,9 +1255,9 @@ QList<QSslCipher> QSslSocket::supportedCiphers()
Searches all files in the \a path for certificates encoded in the
specified \a format and adds them to this socket's CA certificate
database. \a path can be explicit, or it can contain wildcards in
- the format specified by \a syntax. Returns true if one or more
+ the format specified by \a syntax. Returns \c true if one or more
certificates are added to the socket's CA certificate database;
- otherwise returns false.
+ otherwise returns \c false.
The CA certificate database is used by the socket during the
handshake phase to validate the peer's certificate.
@@ -1349,7 +1349,7 @@ QList<QSslCertificate> QSslSocket::caCertificates() const
Searches all files in the \a path for certificates with the
specified \a encoding and adds them to the default CA certificate
database. \a path can be an explicit file, or it can contain
- wildcards in the format specified by \a syntax. Returns true if
+ wildcards in the format specified by \a syntax. Returns \c true if
any CA certificates are added to the default database.
Each SSL socket's CA certificate database is initialized to the
@@ -1442,7 +1442,7 @@ QList<QSslCertificate> QSslSocket::systemCaCertificates()
/*!
Waits until the socket is connected, or \a msecs milliseconds,
whichever happens first. If the connection has been established,
- this function returns true; otherwise it returns false.
+ this function returns \c true; otherwise it returns \c false.
\sa QAbstractSocket::waitForConnected()
*/
@@ -1580,7 +1580,7 @@ bool QSslSocket::waitForBytesWritten(int msecs)
/*!
Waits until the socket has disconnected or \a msecs milliseconds,
whichever comes first. If the connection has been disconnected,
- this function returns true; otherwise it returns false.
+ this function returns \c true; otherwise it returns \c false.
\sa QAbstractSocket::waitForDisconnected()
*/
@@ -1631,7 +1631,7 @@ QList<QSslError> QSslSocket::sslErrors() const
}
/*!
- Returns true if this platform supports SSL; otherwise, returns
+ Returns \c true if this platform supports SSL; otherwise, returns
false. If the platform doesn't support SSL, the socket will fail
in the connection phase.
*/