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/qnetworkcookie.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/qnetworkcookie.cpp')
-rw-r--r-- | src/network/access/qnetworkcookie.cpp | 14 |
1 files changed, 7 insertions, 7 deletions
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). |