diff options
Diffstat (limited to 'src/network')
36 files changed, 188 insertions, 188 deletions
diff --git a/src/network/access/qabstractnetworkcache.cpp b/src/network/access/qabstractnetworkcache.cpp index 69e0d26a0e..01a5d5d4e1 100644 --- a/src/network/access/qabstractnetworkcache.cpp +++ b/src/network/access/qabstractnetworkcache.cpp @@ -158,7 +158,7 @@ QNetworkCacheMetaData &QNetworkCacheMetaData::operator=(const QNetworkCacheMetaD */ /*! - Returns true if this meta data is equal to the \a other meta data; otherwise returns false. + Returns \c true if this meta data is equal to the \a other meta data; otherwise returns \c false. \sa operator!=() */ @@ -174,13 +174,13 @@ bool QNetworkCacheMetaData::operator==(const QNetworkCacheMetaData &other) const /*! \fn bool QNetworkCacheMetaData::operator!=(const QNetworkCacheMetaData &other) const - Returns true if this meta data is not equal to the \a other meta data; otherwise returns false. + Returns \c true if this meta data is not equal to the \a other meta data; otherwise returns \c false. \sa operator==() */ /*! - Returns true if this network cache meta data has attributes that have been set otherwise false. + Returns \c true if this network cache meta data has attributes that have been set otherwise false. */ bool QNetworkCacheMetaData::isValid() const { 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. diff --git a/src/network/access/qhttpmultipart.cpp b/src/network/access/qhttpmultipart.cpp index 5985ed94e0..20860b0fc9 100644 --- a/src/network/access/qhttpmultipart.cpp +++ b/src/network/access/qhttpmultipart.cpp @@ -134,7 +134,7 @@ QHttpPart &QHttpPart::operator=(const QHttpPart &other) */ /*! - Returns true if this object is the same as \a other (i.e., if they + Returns \c true if this object is the same as \a other (i.e., if they have the same headers and body). \sa operator!=() @@ -147,7 +147,7 @@ bool QHttpPart::operator==(const QHttpPart &other) const /*! \fn bool QHttpPart::operator!=(const QHttpPart &other) const - Returns true if this object is not the same as \a other. + Returns \c true if this object is not the same as \a other. \sa operator==() */ diff --git a/src/network/access/qnetworkaccessbackend.cpp b/src/network/access/qnetworkaccessbackend.cpp index 47cd928541..3c5e1e80a8 100644 --- a/src/network/access/qnetworkaccessbackend.cpp +++ b/src/network/access/qnetworkaccessbackend.cpp @@ -374,7 +374,7 @@ void QNetworkAccessBackend::sslErrors(const QList<QSslError> &errors) } /*! - Starts the backend. Returns true if the backend is started. Returns false if the backend + Starts the backend. Returns \c true if the backend is started. Returns \c false if the backend could not be started due to an unopened or roaming session. The caller should recall this function once the session has been opened or the roaming process has finished. */ diff --git a/src/network/access/qnetworkaccessbackend_p.h b/src/network/access/qnetworkaccessbackend_p.h index d9657cf750..dd033e805b 100644 --- a/src/network/access/qnetworkaccessbackend_p.h +++ b/src/network/access/qnetworkaccessbackend_p.h @@ -163,7 +163,7 @@ public: // This will possibly enable buffering of the upload data. virtual bool needsResetableUploadData() { return false; } - // Returns true if backend is able to resume downloads. + // Returns \c true if backend is able to resume downloads. virtual bool canResume() const { return false; } virtual void setResumeOffset(quint64 offset) { Q_UNUSED(offset); } diff --git a/src/network/access/qnetworkaccesscache.cpp b/src/network/access/qnetworkaccesscache.cpp index 4284cb4565..8ee2c3ef27 100644 --- a/src/network/access/qnetworkaccesscache.cpp +++ b/src/network/access/qnetworkaccesscache.cpp @@ -165,7 +165,7 @@ void QNetworkAccessCache::linkEntry(const QByteArray &key) /*! Removes the entry pointed by \a key from the linked list. - Returns true if the entry removed was the oldest one. + Returns \c true if the entry removed was the oldest one. */ bool QNetworkAccessCache::unlinkEntry(const QByteArray &key) { diff --git a/src/network/access/qnetworkcookie.cpp b/src/network/access/qnetworkcookie.cpp index a40a28b03f..a871c04d56 100644 --- a/src/network/access/qnetworkcookie.cpp +++ b/src/network/access/qnetworkcookie.cpp @@ -155,15 +155,15 @@ QNetworkCookie &QNetworkCookie::operator=(const QNetworkCookie &other) /*! \fn bool QNetworkCookie::operator!=(const QNetworkCookie &other) const - Returns true if this cookie is not equal to \a other. + Returns \c true if this cookie is not equal to \a other. \sa operator==() */ /*! \since 5.0 - Returns true if this cookie is equal to \a other. This function - only returns true if all fields of the cookie are the same. + Returns \c true if this cookie is equal to \a other. This function + only returns \c true if all fields of the cookie are the same. However, in some contexts, two cookies of the same name could be considered equal. @@ -184,7 +184,7 @@ bool QNetworkCookie::operator==(const QNetworkCookie &other) const } /*! - Returns true if this cookie has the same identifier tuple as \a other. + Returns \c true if this cookie has the same identifier tuple as \a other. The identifier tuple is composed of the name, domain and path. \sa operator==() @@ -195,7 +195,7 @@ bool QNetworkCookie::hasSameIdentifier(const QNetworkCookie &other) const } /*! - Returns true if the "secure" option was specified in the cookie + Returns \c true if the "secure" option was specified in the cookie string, false otherwise. Secure cookies may contain private information and should not be @@ -224,7 +224,7 @@ void QNetworkCookie::setSecure(bool enable) /*! \since 4.5 - Returns true if the "HttpOnly" flag is enabled for this cookie. + Returns \c true if the "HttpOnly" flag is enabled for this cookie. A cookie that is "HttpOnly" is only set and retrieved by the network requests and replies; i.e., the HTTP protocol. It is not @@ -248,7 +248,7 @@ void QNetworkCookie::setHttpOnly(bool enable) } /*! - Returns true if this cookie is a session cookie. A session cookie + Returns \c true if this cookie is a session cookie. A session cookie is a cookie which has no expiration date, which means it should be discarded when the application's concept of session is over (usually, when the application exits). diff --git a/src/network/access/qnetworkcookiejar.cpp b/src/network/access/qnetworkcookiejar.cpp index b9e7c36149..d6a5986271 100644 --- a/src/network/access/qnetworkcookiejar.cpp +++ b/src/network/access/qnetworkcookiejar.cpp @@ -169,7 +169,7 @@ static inline bool isParentDomain(QString domain, QString reference) Adds the cookies in the list \a cookieList to this cookie jar. Before being inserted cookies are normalized. - Returns true if one or more cookies are set for \a url, + Returns \c true if one or more cookies are set for \a url, otherwise false. If a cookie already exists in the cookie jar, it will be @@ -265,7 +265,7 @@ QList<QNetworkCookie> QNetworkCookieJar::cookiesForUrl(const QUrl &url) const \since 5.0 Adds \a cookie to this cookie jar. - Returns true if \a cookie was added, false otherwise. + Returns \c true if \a cookie was added, false otherwise. If a cookie with the same identifier already exists in the cookie jar, it will be overridden. @@ -291,7 +291,7 @@ bool QNetworkCookieJar::insertCookie(const QNetworkCookie &cookie) If a cookie with the same identifier as \a cookie exists in this cookie jar it will be updated. This function uses insertCookie(). - Returns true if \a cookie was updated, false if no cookie in the jar matches + Returns \c true if \a cookie was updated, false if no cookie in the jar matches the identifier of \a cookie. \sa QNetworkCookie::hasSameIdentifier() @@ -307,7 +307,7 @@ bool QNetworkCookieJar::updateCookie(const QNetworkCookie &cookie) \since 5.0 Deletes from cookie jar the cookie found to have the same identifier as \a cookie. - Returns true if a cookie was deleted, false otherwise. + Returns \c true if a cookie was deleted, false otherwise. \sa QNetworkCookie::hasSameIdentifier() */ @@ -325,7 +325,7 @@ bool QNetworkCookieJar::deleteCookie(const QNetworkCookie &cookie) /*! \since 5.0 - Returns true if the domain and path of \a cookie are valid, false otherwise. + Returns \c true if the domain and path of \a cookie are valid, false otherwise. The \a url parameter is used to determine if the domain specified in the cookie is allowed. */ diff --git a/src/network/access/qnetworkdiskcache.cpp b/src/network/access/qnetworkdiskcache.cpp index 064f87c2c0..d64d697013 100644 --- a/src/network/access/qnetworkdiskcache.cpp +++ b/src/network/access/qnetworkdiskcache.cpp @@ -685,7 +685,7 @@ void QCacheItem::writeCompressedData(QFile *device) const } /*! - Returns false if the file is a cache file, + Returns \c false if the file is a cache file, but is an older version and should be removed otherwise true. */ bool QCacheItem::read(QFile *device, bool readData) diff --git a/src/network/access/qnetworkreply.cpp b/src/network/access/qnetworkreply.cpp index dc42adc612..ba6f706f7a 100644 --- a/src/network/access/qnetworkreply.cpp +++ b/src/network/access/qnetworkreply.cpp @@ -490,7 +490,7 @@ QNetworkReply::NetworkError QNetworkReply::error() const /*! \since 4.6 - Returns true when the reply has finished or was aborted. + Returns \c true when the reply has finished or was aborted. \sa isRunning() */ @@ -502,7 +502,7 @@ bool QNetworkReply::isFinished() const /*! \since 4.6 - Returns true when the request is still processing and the + Returns \c true when the request is still processing and the reply has not finished or was aborted yet. \sa isFinished() @@ -536,7 +536,7 @@ QVariant QNetworkReply::header(QNetworkRequest::KnownHeaders header) const } /*! - Returns true if the raw header of name \a headerName was sent by + Returns \c true if the raw header of name \a headerName was sent by the remote server \sa rawHeader() diff --git a/src/network/access/qnetworkreplyhttpimpl.cpp b/src/network/access/qnetworkreplyhttpimpl.cpp index ddef970966..29d23bfd8f 100644 --- a/src/network/access/qnetworkreplyhttpimpl.cpp +++ b/src/network/access/qnetworkreplyhttpimpl.cpp @@ -1521,7 +1521,7 @@ void QNetworkReplyHttpImplPrivate::setResumeOffset(quint64 offset) } /*! - Starts the backend. Returns true if the backend is started. Returns false if the backend + Starts the backend. Returns \c true if the backend is started. Returns \c false if the backend could not be started due to an unopened or roaming session. The caller should recall this function once the session has been opened or the roaming process has finished. */ @@ -1961,7 +1961,7 @@ void QNetworkReplyHttpImplPrivate::metaDataChanged() /* Migrates the backend of the QNetworkReply to a new network connection if required. Returns - true if the reply is migrated or it is not required; otherwise returns false. + true if the reply is migrated or it is not required; otherwise returns \c false. */ bool QNetworkReplyHttpImplPrivate::migrateBackend() { diff --git a/src/network/access/qnetworkreplyimpl.cpp b/src/network/access/qnetworkreplyimpl.cpp index 33357293a3..f51b85cba0 100644 --- a/src/network/access/qnetworkreplyimpl.cpp +++ b/src/network/access/qnetworkreplyimpl.cpp @@ -1079,7 +1079,7 @@ bool QNetworkReplyImpl::event(QEvent *e) /* Migrates the backend of the QNetworkReply to a new network connection if required. Returns - true if the reply is migrated or it is not required; otherwise returns false. + true if the reply is migrated or it is not required; otherwise returns \c false. */ bool QNetworkReplyImplPrivate::migrateBackend() { diff --git a/src/network/access/qnetworkrequest.cpp b/src/network/access/qnetworkrequest.cpp index 00d5b81413..65fd693771 100644 --- a/src/network/access/qnetworkrequest.cpp +++ b/src/network/access/qnetworkrequest.cpp @@ -369,7 +369,7 @@ QNetworkRequest::~QNetworkRequest() } /*! - Returns true if this object is the same as \a other (i.e., if they + Returns \c true if this object is the same as \a other (i.e., if they have the same URL, same headers and same meta-data settings). \sa operator!=() @@ -382,7 +382,7 @@ bool QNetworkRequest::operator==(const QNetworkRequest &other) const /*! \fn bool QNetworkRequest::operator!=(const QNetworkRequest &other) const - Returns false if this object is not the same as \a other. + Returns \c false if this object is not the same as \a other. \sa operator==() */ @@ -449,7 +449,7 @@ void QNetworkRequest::setHeader(KnownHeaders header, const QVariant &value) } /*! - Returns true if the raw header \a headerName is present in this + Returns \c true if the raw header \a headerName is present in this network request. \sa rawHeader(), setRawHeader() diff --git a/src/network/bearer/qbearerengine.cpp b/src/network/bearer/qbearerengine.cpp index e07426025e..520323471a 100644 --- a/src/network/bearer/qbearerengine.cpp +++ b/src/network/bearer/qbearerengine.cpp @@ -82,9 +82,9 @@ bool QBearerEngine::requiresPolling() const } /* - Returns true if configurations are in use; otherwise returns false. + Returns \c true if configurations are in use; otherwise returns \c false. - If configurations are in use and requiresPolling() returns true, polling will be enabled for + If configurations are in use and requiresPolling() returns \c true, polling will be enabled for this engine. */ bool QBearerEngine::configurationsInUse() const diff --git a/src/network/bearer/qnetworkconfigmanager.cpp b/src/network/bearer/qnetworkconfigmanager.cpp index 933bebe2ad..dc36443718 100644 --- a/src/network/bearer/qnetworkconfigmanager.cpp +++ b/src/network/bearer/qnetworkconfigmanager.cpp @@ -321,8 +321,8 @@ QNetworkConfiguration QNetworkConfigurationManager::configurationFromIdentifier( } /*! - Returns true if the system is considered to be connected to another device via an active - network interface; otherwise returns false. + Returns \c true if the system is considered to be connected to another device via an active + network interface; otherwise returns \c false. This is equivalent to the following code snippet: diff --git a/src/network/bearer/qnetworkconfiguration.cpp b/src/network/bearer/qnetworkconfiguration.cpp index 40381a04c0..8d34db19cd 100644 --- a/src/network/bearer/qnetworkconfiguration.cpp +++ b/src/network/bearer/qnetworkconfiguration.cpp @@ -331,8 +331,8 @@ QNetworkConfiguration &QNetworkConfiguration::operator=(const QNetworkConfigurat */ /*! - Returns true, if this configuration is the same as the \a other - configuration given; otherwise returns false. + Returns \c true, if this configuration is the same as the \a other + configuration given; otherwise returns \c false. */ bool QNetworkConfiguration::operator==(const QNetworkConfiguration &other) const { @@ -342,8 +342,8 @@ bool QNetworkConfiguration::operator==(const QNetworkConfiguration &other) const /*! \fn bool QNetworkConfiguration::operator!=(const QNetworkConfiguration &other) const - Returns true if this configuration is not the same as the \a other - configuration given; otherwise returns false. + Returns \c true if this configuration is not the same as the \a other + configuration given; otherwise returns \c false. */ /*! @@ -392,7 +392,7 @@ QNetworkConfiguration::Type QNetworkConfiguration::type() const } /*! - Returns true if this QNetworkConfiguration object is valid. + Returns \c true if this QNetworkConfiguration object is valid. A configuration may become invalid if the user deletes the configuration or the configuration was default-constructed. @@ -439,7 +439,7 @@ QNetworkConfiguration::Purpose QNetworkConfiguration::purpose() const } /*! - Returns true if this configuration supports roaming; otherwise false. + Returns \c true if this configuration supports roaming; otherwise false. */ bool QNetworkConfiguration::isRoamingAvailable() const { diff --git a/src/network/bearer/qnetworksession.cpp b/src/network/bearer/qnetworksession.cpp index cca95fce8c..98a8f27a6e 100644 --- a/src/network/bearer/qnetworksession.cpp +++ b/src/network/bearer/qnetworksession.cpp @@ -314,7 +314,7 @@ void QNetworkSession::open() /*! Waits until the session has been opened, up to \a msecs milliseconds. If the session has been opened, this - function returns true; otherwise it returns false. In the case where it returns false, you can call error() + function returns \c true; otherwise it returns \c false. In the case where it returns \c false, you can call error() to determine the cause of the error. The following example waits up to one second for the session to be opened: @@ -415,7 +415,7 @@ QNetworkInterface QNetworkSession::interface() const #endif /*! - Returns true if this session is open. If the number of all open sessions is greater than + Returns \c true if this session is open. If the number of all open sessions is greater than zero the underlying network interface will remain connected/up. The session can be controlled via open() and close(). diff --git a/src/network/doc/src/bearermanagement.qdoc b/src/network/doc/src/bearermanagement.qdoc index b818057c35..63022b6a6f 100644 --- a/src/network/doc/src/bearermanagement.qdoc +++ b/src/network/doc/src/bearermanagement.qdoc @@ -177,7 +177,7 @@ and an \l{QNetworkSession::isOpen()}{isOpen()} condition. The state() attribute enables developers to detect whether the system currently maintains a global network session for the given QNetworkConfiguration. If \l {QNetworkSession::isOpen()}{isOpen()} -returns true the QNetworkSession instance at hand was at least one of the +returns \c true the QNetworkSession instance at hand was at least one of the entities requesting the global network session. This distinction is required to support the notion of session registrations. For as long as there are one or more open QNetworkSession instances the underlying diff --git a/src/network/kernel/qauthenticator.cpp b/src/network/kernel/qauthenticator.cpp index 0ea97f25a6..e1a24a226f 100644 --- a/src/network/kernel/qauthenticator.cpp +++ b/src/network/kernel/qauthenticator.cpp @@ -197,8 +197,8 @@ QAuthenticator &QAuthenticator::operator=(const QAuthenticator &other) } /*! - Returns true if this authenticator is identical to \a other; otherwise - returns false. + Returns \c true if this authenticator is identical to \a other; otherwise + returns \c false. */ bool QAuthenticator::operator==(const QAuthenticator &other) const { @@ -214,8 +214,8 @@ bool QAuthenticator::operator==(const QAuthenticator &other) const /*! \fn bool QAuthenticator::operator!=(const QAuthenticator &other) const - Returns true if this authenticator is different from \a other; otherwise - returns false. + Returns \c true if this authenticator is different from \a other; otherwise + returns \c false. */ /*! @@ -320,7 +320,7 @@ void QAuthenticator::setOption(const QString &opt, const QVariant &value) /*! - Returns true if the authenticator is null. + Returns \c true if the authenticator is null. */ bool QAuthenticator::isNull() const { diff --git a/src/network/kernel/qhostaddress.cpp b/src/network/kernel/qhostaddress.cpp index 5ef428305c..18fd6dee58 100644 --- a/src/network/kernel/qhostaddress.cpp +++ b/src/network/kernel/qhostaddress.cpp @@ -530,15 +530,15 @@ QHostAddress &QHostAddress::operator=(const QString &address) \fn bool QHostAddress::operator!=(const QHostAddress &other) const \since 4.2 - Returns true if this host address is not the same as the \a other - address given; otherwise returns false. + Returns \c true if this host address is not the same as the \a other + address given; otherwise returns \c false. */ /*! \fn bool QHostAddress::operator!=(SpecialAddress other) const - Returns true if this host address is not the same as the \a other - address given; otherwise returns false. + Returns \c true if this host address is not the same as the \a other + address given; otherwise returns \c false. */ /*! @@ -585,8 +585,8 @@ void QHostAddress::setAddress(const Q_IPV6ADDR &ip6Addr) Sets the IPv4 or IPv6 address specified by the string representation specified by \a address (e.g. "127.0.0.1"). - Returns true and sets the address if the address was successfully - parsed; otherwise returns false. + Returns \c true and sets the address if the address was successfully + parsed; otherwise returns \c false. */ bool QHostAddress::setAddress(const QString &address) { @@ -599,8 +599,8 @@ bool QHostAddress::setAddress(const QString &address) \overload Sets the IPv4 or IPv6 address specified by the native structure \a - sockaddr. Returns true and sets the address if the address was - successfully parsed; otherwise returns false. + sockaddr. Returns \c true and sets the address if the address was + successfully parsed; otherwise returns \c false. */ void QHostAddress::setAddress(const struct sockaddr *sockaddr) { @@ -754,8 +754,8 @@ void QHostAddress::setScopeId(const QString &id) } /*! - Returns true if this host address is the same as the \a other address - given; otherwise returns false. + Returns \c true if this host address is the same as the \a other address + given; otherwise returns \c false. */ bool QHostAddress::operator==(const QHostAddress &other) const { @@ -772,8 +772,8 @@ bool QHostAddress::operator==(const QHostAddress &other) const } /*! - Returns true if this host address is the same as the \a other - address given; otherwise returns false. + Returns \c true if this host address is the same as the \a other + address given; otherwise returns \c false. */ bool QHostAddress::operator ==(SpecialAddress other) const { @@ -793,7 +793,7 @@ bool QHostAddress::operator ==(SpecialAddress other) const } /*! - Returns true if this host address is null (INADDR_ANY or in6addr_any). + Returns \c true if this host address is null (INADDR_ANY or in6addr_any). The default constructor creates a null address, and that address is not valid for any host or interface. */ @@ -806,7 +806,7 @@ bool QHostAddress::isNull() const /*! \since 4.5 - Returns true if this IP is in the subnet described by the network + Returns \c true if this IP is in the subnet described by the network prefix \a subnet and netmask \a netmask. An IP is considered to belong to a subnet if it is contained @@ -866,7 +866,7 @@ bool QHostAddress::isInSubnet(const QHostAddress &subnet, int netmask) const \since 4.5 \overload - Returns true if this IP is in the subnet described by \a + Returns \c true if this IP is in the subnet described by \a subnet. The QHostAddress member of \a subnet contains the network prefix and the int (second) member contains the netmask (prefix length). @@ -1002,7 +1002,7 @@ QPair<QHostAddress, int> QHostAddress::parseSubnet(const QString &subnet) /*! \since 5.0 - returns true if the address is the IPv6 loopback address, or any + returns \c true if the address is the IPv6 loopback address, or any of the IPv4 loopback addresses. */ bool QHostAddress::isLoopback() const diff --git a/src/network/kernel/qnetworkinterface.cpp b/src/network/kernel/qnetworkinterface.cpp index f47638db86..632b0cd156 100644 --- a/src/network/kernel/qnetworkinterface.cpp +++ b/src/network/kernel/qnetworkinterface.cpp @@ -201,7 +201,7 @@ QNetworkAddressEntry::~QNetworkAddressEntry() } /*! - Returns true if this network address entry is the same as \a + Returns \c true if this network address entry is the same as \a other. */ bool QNetworkAddressEntry::operator==(const QNetworkAddressEntry &other) const @@ -216,7 +216,7 @@ bool QNetworkAddressEntry::operator==(const QNetworkAddressEntry &other) const /*! \fn bool QNetworkAddressEntry::operator!=(const QNetworkAddressEntry &other) const - Returns true if this network address entry is different from \a + Returns \c true if this network address entry is different from \a other. */ @@ -435,7 +435,7 @@ QNetworkInterface &QNetworkInterface::operator=(const QNetworkInterface &other) */ /*! - Returns true if this QNetworkInterface object contains valid + Returns \c true if this QNetworkInterface object contains valid information about a network interface. */ bool QNetworkInterface::isValid() const diff --git a/src/network/kernel/qnetworkproxy.cpp b/src/network/kernel/qnetworkproxy.cpp index a38655d244..5cc41392b5 100644 --- a/src/network/kernel/qnetworkproxy.cpp +++ b/src/network/kernel/qnetworkproxy.cpp @@ -499,7 +499,7 @@ QNetworkProxy::~QNetworkProxy() /*! \since 4.4 - Compares the value of this network proxy to \a other and returns true + Compares the value of this network proxy to \a other and returns \c true if they are equal (same proxy type, server as well as username and password) */ bool QNetworkProxy::operator==(const QNetworkProxy &other) const @@ -511,7 +511,7 @@ bool QNetworkProxy::operator==(const QNetworkProxy &other) const \fn bool QNetworkProxy::operator!=(const QNetworkProxy &other) const \since 4.4 - Compares the value of this network proxy to \a other and returns true + Compares the value of this network proxy to \a other and returns \c true if they differ. \*/ @@ -588,7 +588,7 @@ QNetworkProxy::Capabilities QNetworkProxy::capabilities() const /*! \since 4.4 - Returns true if this proxy supports the + Returns \c true if this proxy supports the QNetworkProxy::CachingCapability capability. In Qt 4.4, the capability was tied to the proxy type, but since Qt @@ -605,7 +605,7 @@ bool QNetworkProxy::isCachingProxy() const /*! \since 4.4 - Returns true if this proxy supports transparent tunneling of TCP + Returns \c true if this proxy supports transparent tunneling of TCP connections. This matches the QNetworkProxy::TunnelingCapability capability. @@ -775,8 +775,8 @@ void QNetworkProxy::setHeader(QNetworkRequest::KnownHeaders header, const QVaria /*! \since 5.0 - Returns true if the raw header \a headerName is in use for this - proxy. Returns false if the proxy is not of type HttpProxy or + Returns \c true if the raw header \a headerName is in use for this + proxy. Returns \c false if the proxy is not of type HttpProxy or HttpCachingProxy. \sa rawHeader(), setRawHeader() @@ -1165,7 +1165,7 @@ QNetworkProxyQuery &QNetworkProxyQuery::operator=(const QNetworkProxyQuery &othe */ /*! - Returns true if this QNetworkProxyQuery object contains the same + Returns \c true if this QNetworkProxyQuery object contains the same data as \a other. */ bool QNetworkProxyQuery::operator==(const QNetworkProxyQuery &other) const @@ -1176,7 +1176,7 @@ bool QNetworkProxyQuery::operator==(const QNetworkProxyQuery &other) const /*! \fn bool QNetworkProxyQuery::operator!=(const QNetworkProxyQuery &other) const - Returns true if this QNetworkProxyQuery object does not contain + Returns \c true if this QNetworkProxyQuery object does not contain the same data as \a other. */ diff --git a/src/network/kernel/qurlinfo.cpp b/src/network/kernel/qurlinfo.cpp index 89d48639cf..a4200789cd 100644 --- a/src/network/kernel/qurlinfo.cpp +++ b/src/network/kernel/qurlinfo.cpp @@ -545,7 +545,7 @@ QDateTime QUrlInfo::lastRead() const } /*! - Returns true if the URL is a directory; otherwise returns false. + Returns \c true if the URL is a directory; otherwise returns \c false. \sa isValid() */ @@ -558,7 +558,7 @@ bool QUrlInfo::isDir() const } /*! - Returns true if the URL is a file; otherwise returns false. + Returns \c true if the URL is a file; otherwise returns \c false. \sa isValid() */ @@ -571,7 +571,7 @@ bool QUrlInfo::isFile() const } /*! - Returns true if the URL is a symbolic link; otherwise returns false. + Returns \c true if the URL is a symbolic link; otherwise returns \c false. \sa isValid() */ @@ -584,7 +584,7 @@ bool QUrlInfo::isSymLink() const } /*! - Returns true if the URL is writable; otherwise returns false. + Returns \c true if the URL is writable; otherwise returns \c false. \sa isValid() */ @@ -597,7 +597,7 @@ bool QUrlInfo::isWritable() const } /*! - Returns true if the URL is readable; otherwise returns false. + Returns \c true if the URL is readable; otherwise returns \c false. \sa isValid() */ @@ -610,7 +610,7 @@ bool QUrlInfo::isReadable() const } /*! - Returns true if the URL is executable; otherwise returns false. + Returns \c true if the URL is executable; otherwise returns \c false. \sa isValid() */ @@ -623,7 +623,7 @@ bool QUrlInfo::isExecutable() const } /*! - Returns true if \a i1 is greater than \a i2; otherwise returns + Returns \c true if \a i1 is greater than \a i2; otherwise returns false. The objects are compared by the value, which is specified by \a sortBy. This must be one of QDir::Name, QDir::Time or QDir::Size. @@ -645,7 +645,7 @@ bool QUrlInfo::greaterThan(const QUrlInfo &i1, const QUrlInfo &i2, } /*! - Returns true if \a i1 is less than \a i2; otherwise returns false. + Returns \c true if \a i1 is less than \a i2; otherwise returns \c false. The objects are compared by the value, which is specified by \a sortBy. This must be one of QDir::Name, QDir::Time or QDir::Size. */ @@ -657,7 +657,7 @@ bool QUrlInfo::lessThan(const QUrlInfo &i1, const QUrlInfo &i2, } /*! - Returns true if \a i1 equals to \a i2; otherwise returns false. + Returns \c true if \a i1 equals to \a i2; otherwise returns \c false. The objects are compared by the value, which is specified by \a sortBy. This must be one of QDir::Name, QDir::Time or QDir::Size. */ @@ -678,8 +678,8 @@ bool QUrlInfo::equal(const QUrlInfo &i1, const QUrlInfo &i2, } /*! - Returns true if this QUrlInfo is equal to \a other; otherwise - returns false. + Returns \c true if this QUrlInfo is equal to \a other; otherwise + returns \c false. \sa lessThan(), equal() */ @@ -710,14 +710,14 @@ bool QUrlInfo::operator==(const QUrlInfo &other) const \fn bool QUrlInfo::operator!=(const QUrlInfo &other) const \since 4.2 - Returns true if this QUrlInfo is not equal to \a other; otherwise - returns false. + Returns \c true if this QUrlInfo is not equal to \a other; otherwise + returns \c false. \sa lessThan(), equal() */ /*! - Returns true if the URL info is valid; otherwise returns false. + Returns \c true if the URL info is valid; otherwise returns \c false. Valid means that the QUrlInfo contains real information. You should always check if the URL info is valid before relying on diff --git a/src/network/socket/qabstractsocket.cpp b/src/network/socket/qabstractsocket.cpp index 084e0bc656..47fec38283 100644 --- a/src/network/socket/qabstractsocket.cpp +++ b/src/network/socket/qabstractsocket.cpp @@ -87,7 +87,7 @@ connection has been established, it enters ConnectedState and emits connected(). If an error occurs at any stage, error() is emitted. Whenever the state changes, stateChanged() is emitted. - For convenience, isValid() returns true if the socket is ready for + For convenience, isValid() returns \c true if the socket is ready for reading and writing, but note that the socket's state must be ConnectedState before reading and writing can occur. @@ -143,7 +143,7 @@ \snippet network/tcpwait.cpp 0 - If \l{QIODevice::}{waitForReadyRead()} returns false, the + If \l{QIODevice::}{waitForReadyRead()} returns \c false, the connection has been closed or an error has occurred. Programming with a blocking socket is radically different from @@ -1464,8 +1464,8 @@ void QAbstractSocket::setPauseMode(PauseModes pauseMode) By default, the socket is bound using the DefaultForPlatform BindMode. If a port is not specified, a random port is chosen. - On success, the functions returns true and the socket enters - BoundState; otherwise it returns false. + On success, the functions returns \c true and the socket enters + BoundState; otherwise it returns \c false. */ bool QAbstractSocket::bind(const QHostAddress &address, quint16 port, BindMode mode) @@ -1537,8 +1537,8 @@ bool QAbstractSocket::bind(quint16 port, BindMode mode) } /*! - Returns true if the socket is valid and ready for use; otherwise - returns false. + Returns \c true if the socket is valid and ready for use; otherwise + returns \c false. \b{Note:} The socket's state must be ConnectedState before reading and writing can occur. @@ -1782,8 +1782,8 @@ QString QAbstractSocket::peerName() const } /*! - Returns true if a line of data can be read from the socket; - otherwise returns false. + Returns \c true if a line of data can be read from the socket; + otherwise returns \c false. \sa readLine() */ @@ -1817,8 +1817,8 @@ qintptr QAbstractSocket::socketDescriptor() const /*! Initializes QAbstractSocket 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 socketState. @@ -1960,8 +1960,8 @@ static int qt_timeout_value(int msecs, int elapsed) /*! Waits until the socket is connected, up to \a msecs milliseconds. If the connection has been established, this - function returns true; otherwise it returns false. In the case - where it returns false, you can call error() to determine + function returns \c true; otherwise it returns \c false. In the case + where it returns \c false, you can call error() to determine the cause of the error. The following example waits up to one second for a connection @@ -2072,8 +2072,8 @@ bool QAbstractSocket::waitForConnected(int msecs) will timeout after \a msecs milliseconds; the default timeout is 30000 milliseconds. - The function returns true if the readyRead() signal is emitted and - there is new data available for reading; otherwise it returns false + The function returns \c true if the readyRead() signal is emitted and + there is new data available for reading; otherwise it returns \c false (if an error occurred or the operation timed out). \sa waitForBytesWritten() @@ -2190,7 +2190,7 @@ bool QAbstractSocket::waitForBytesWritten(int msecs) if (readyToWrite) { if (d->canWriteNotification()) { #if defined (QABSTRACTSOCKET_DEBUG) - qDebug("QAbstractSocket::waitForBytesWritten returns true"); + qDebug("QAbstractSocket::waitForBytesWritten returns \c true"); #endif return true; } @@ -2205,8 +2205,8 @@ bool QAbstractSocket::waitForBytesWritten(int msecs) /*! Waits until the socket has disconnected, up to \a msecs milliseconds. If the connection has been disconnected, this - function returns true; otherwise it returns false. In the case - where it returns false, you can call error() to determine + function returns \c true; otherwise it returns \c false. In the case + where it returns \c false, you can call error() to determine the cause of the error. The following example waits up to one second for a connection @@ -2309,8 +2309,8 @@ bool QAbstractSocket::isSequential() const /*! \reimp - Returns true if no more data is currently - available for reading; otherwise returns false. + Returns \c true if no more data is currently + available for reading; otherwise returns \c false. This function is most commonly used when reading data from the socket in a loop. For example: @@ -2327,7 +2327,7 @@ bool QAbstractSocket::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 QAbstractSocket to start sending buffered data immediately. The number of bytes successfully written depends on the diff --git a/src/network/socket/qlocalserver.cpp b/src/network/socket/qlocalserver.cpp index 95782cc1c3..f7f8aab182 100644 --- a/src/network/socket/qlocalserver.cpp +++ b/src/network/socket/qlocalserver.cpp @@ -218,8 +218,8 @@ QString QLocalServer::errorString() const } /*! - Returns true if the server has a pending connection; otherwise - returns false. + Returns \c true if the server has a pending connection; otherwise + returns \c false. \sa nextPendingConnection(), setMaxPendingConnections() */ @@ -254,7 +254,7 @@ void QLocalServer::incomingConnection(quintptr socketDescriptor) } /*! - Returns true if the server is listening for incoming connections + Returns \c true if the server is listening for incoming connections otherwise false. \sa listen(), close() @@ -399,7 +399,7 @@ QLocalSocket *QLocalServer::nextPendingConnection() \since 4.5 Removes any server instance that might cause a call to listen() to fail - and returns true if successful; otherwise returns false. + and returns \c true if successful; otherwise returns \c false. This function is meant to recover from a crash, when the previous server instance has not been cleaned up. @@ -470,8 +470,8 @@ void QLocalServer::setMaxPendingConnections(int numConnections) /*! Waits for at most \a msec milliseconds or until an incoming connection - is available. Returns true if a connection is available; otherwise - returns false. If the operation timed out and \a timedOut is not 0, + is available. Returns \c true if a connection is available; otherwise + returns \c false. If the operation timed out and \a timedOut is not 0, *timedOut will be set to true. This is a blocking function call. Its use is ill-advised in a diff --git a/src/network/socket/qlocalsocket.cpp b/src/network/socket/qlocalsocket.cpp index f516b932e7..d4251672db 100644 --- a/src/network/socket/qlocalsocket.cpp +++ b/src/network/socket/qlocalsocket.cpp @@ -114,8 +114,8 @@ QT_BEGIN_NAMESPACE LocalSocketState socketState, OpenMode openMode) Initializes QLocalSocket with the native socket descriptor - \a socketDescriptor. Returns true if socketDescriptor is accepted - as a valid socket descriptor; otherwise returns false. The socket is + \a socketDescriptor. Returns \c true if 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 socketState. @@ -187,7 +187,7 @@ QT_BEGIN_NAMESPACE This function writes as much as possible from the internal write buffer to the socket, without blocking. If any data was written, this function - returns true; otherwise false is returned. + returns \c true; otherwise false is returned. Call this function if you need QLocalSocket to start sending buffered data immediately. The number of bytes successfully written depends on the @@ -221,8 +221,8 @@ QT_BEGIN_NAMESPACE /*! \fn bool QLocalSocket::isValid() const - Returns true if the socket is valid and ready for use; otherwise - returns false. + Returns \c true if the socket is valid and ready for use; otherwise + returns \c false. \note The socket's state must be ConnectedState before reading and writing can occur. @@ -263,8 +263,8 @@ QT_BEGIN_NAMESPACE \fn bool QLocalSocket::waitForConnected(int msecs) Waits until the socket is connected, up to \a msecs milliseconds. If the - connection has been established, this function returns true; otherwise - it returns false. In the case where it returns false, you can call + connection has been established, this function returns \c true; otherwise + it returns \c false. In the case where it returns \c false, you can call error() to determine the cause of the error. The following example waits up to one second for a connection @@ -282,8 +282,8 @@ QT_BEGIN_NAMESPACE Waits until the socket has disconnected, up to \a msecs milliseconds. If the connection has been disconnected, this - function returns true; otherwise it returns false. In the case - where it returns false, you can call error() to determine + function returns \c true; otherwise it returns \c false. In the case + where it returns \c false, you can call error() to determine the cause of the error. The following example waits up to one second for a connection @@ -304,8 +304,8 @@ QT_BEGIN_NAMESPACE will timeout after \a msecs milliseconds; the default timeout is 30000 milliseconds. - The function returns true if data is available for reading; - otherwise it returns false (if an error occurred or the + The function returns \c true if data is available for reading; + otherwise it returns \c false (if an error occurred or the operation timed out). \sa waitForBytesWritten() diff --git a/src/network/socket/qnativesocketengine.cpp b/src/network/socket/qnativesocketengine.cpp index 536bc63ed0..6bf8626f97 100644 --- a/src/network/socket/qnativesocketengine.cpp +++ b/src/network/socket/qnativesocketengine.cpp @@ -335,8 +335,8 @@ QNativeSocketEngine::~QNativeSocketEngine() /*! Initializes a QNativeSocketEngine by creating a new socket of type \a - socketType and network layer protocol \a protocol. Returns true on - success; otherwise returns false. + socketType and network layer protocol \a protocol. Returns \c true on + success; otherwise returns \c false. If the socket was already initialized, this function closes the socket before reeinitializing it. @@ -461,7 +461,7 @@ bool QNativeSocketEngine::initialize(qintptr socketDescriptor, QAbstractSocket:: } /*! - Returns true if the socket is valid; otherwise returns false. A + Returns \c true if the socket is valid; otherwise returns \c false. A socket is valid if it has not been successfully initialized, or if it has been closed. */ @@ -483,7 +483,7 @@ qintptr QNativeSocketEngine::socketDescriptor() const /*! Connects to the IP address and port specified by \a address and \a - port. If the connection is established, this function returns true + port. If the connection is established, this function returns \c true and the socket enters ConnectedState. Otherwise, false is returned. @@ -559,7 +559,7 @@ bool QNativeSocketEngine::connectToHostByName(const QString &name, quint16 port) /*! Binds the socket to the address \a address and port \a - port. Returns true on success; otherwise false is returned. The + port. Returns \c true on success; otherwise false is returned. The port may be 0, in which case an arbitrary unused port is assigned automatically by the operating system. @@ -708,7 +708,7 @@ qint64 QNativeSocketEngine::bytesAvailable() const } /*! - Returns true if there is at least one datagram pending. This + Returns \c true if there is at least one datagram pending. This function is only called by UDP sockets, where a datagram can have a size of 0. TCP sockets call bytesAvailable(). */ @@ -880,7 +880,7 @@ void QNativeSocketEngine::close() reading. If \a timedOut is not 0 and \a msecs milliseconds have passed, the value of \a timedOut is set to true. - Returns true if data is available for reading; otherwise returns + Returns \c true if data is available for reading; otherwise returns false. This is a blocking function call; its use is disadvised in a @@ -920,7 +920,7 @@ bool QNativeSocketEngine::waitForRead(int msecs, bool *timedOut) writing. If \a timedOut is not 0 and \a msecs milliseconds have passed, the value of \a timedOut is set to true. - Returns true if data is available for writing; otherwise returns + Returns \c true if data is available for writing; otherwise returns false. This is a blocking function call; its use is disadvised in a diff --git a/src/network/socket/qtcpserver.cpp b/src/network/socket/qtcpserver.cpp index 896980f849..31215ee307 100644 --- a/src/network/socket/qtcpserver.cpp +++ b/src/network/socket/qtcpserver.cpp @@ -271,7 +271,7 @@ QTcpServer::~QTcpServer() automatically. If \a address is QHostAddress::Any, the server will listen on all network interfaces. - Returns true on success; otherwise returns false. + Returns \c true on success; otherwise returns \c false. \sa isListening() */ @@ -351,8 +351,8 @@ bool QTcpServer::listen(const QHostAddress &address, quint16 port) } /*! - Returns true if the server is currently listening for incoming - connections; otherwise returns false. + Returns \c true if the server is currently listening for incoming + connections; otherwise returns \c false. \sa listen() */ @@ -408,8 +408,8 @@ qintptr QTcpServer::socketDescriptor() const /*! Sets the socket descriptor this server should use when listening - for incoming connections to \a socketDescriptor. Returns true if - the socket is set successfully; otherwise returns false. + for incoming connections to \a socketDescriptor. Returns \c true if + the socket is set successfully; otherwise returns \c false. The socket is assumed to be in listening state. @@ -486,8 +486,8 @@ QHostAddress QTcpServer::serverAddress() const /*! Waits for at most \a msec milliseconds or until an incoming - connection is available. Returns true if a connection is - available; otherwise returns false. If the operation timed out + connection is available. Returns \c true if a connection is + available; otherwise returns \c false. If the operation timed out and \a timedOut is not 0, *\a timedOut will be set to true. This is a blocking function call. Its use is disadvised in a @@ -524,8 +524,8 @@ bool QTcpServer::waitForNewConnection(int msec, bool *timedOut) } /*! - Returns true if the server has a pending connection; otherwise - returns false. + Returns \c true if the server has a pending connection; otherwise + returns \c false. \sa nextPendingConnection(), setMaxPendingConnections() */ diff --git a/src/network/socket/qudpsocket.cpp b/src/network/socket/qudpsocket.cpp index a01fdd4646..de2fc22018 100644 --- a/src/network/socket/qudpsocket.cpp +++ b/src/network/socket/qudpsocket.cpp @@ -66,7 +66,7 @@ you don't need to call bind(). The readyRead() signal is emitted whenever datagrams arrive. In - that case, hasPendingDatagrams() returns true. Call + that case, hasPendingDatagrams() returns \c true. Call pendingDatagramSize() to obtain the size of the first pending datagram, and readDatagram() to read it. @@ -182,7 +182,7 @@ QUdpSocket::~QUdpSocket() be bound using IPv6 (or in dual mode, using QHostAddress::Any). You must use QHostAddress::AnyIPv4 instead. - This function returns true if successful; otherwise it returns false + This function returns \c true if successful; otherwise it returns \c false and sets the socket error accordingly. \sa leaveMulticastGroup() @@ -216,7 +216,7 @@ bool QUdpSocket::joinMulticastGroup(const QHostAddress &groupAddress, interface chosen by the operating system. The socket must be in BoundState, otherwise an error occurs. - This function returns true if successful; otherwise it returns false and + This function returns \c true if successful; otherwise it returns \c false and sets the socket error accordingly. \sa joinMulticastGroup() @@ -284,8 +284,8 @@ void QUdpSocket::setMulticastInterface(const QNetworkInterface &iface) #endif // QT_NO_NETWORKINTERFACE /*! - Returns true if at least one datagram is waiting to be read; - otherwise returns false. + Returns \c true if at least one datagram is waiting to be read; + otherwise returns \c false. \sa pendingDatagramSize(), readDatagram() */ 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. */ |