From 4533cc994484a2308297e64e99af005fb4dca065 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 2 Oct 2013 16:51:05 +0200 Subject: 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 Reviewed-by: Jerome Pasion --- src/corelib/mimetypes/qmimetype.cpp | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'src/corelib/mimetypes') diff --git a/src/corelib/mimetypes/qmimetype.cpp b/src/corelib/mimetypes/qmimetype.cpp index 31237797df..0ffa186d2e 100644 --- a/src/corelib/mimetypes/qmimetype.cpp +++ b/src/corelib/mimetypes/qmimetype.cpp @@ -177,7 +177,7 @@ QMimeType::~QMimeType() /*! \fn bool QMimeType::operator==(const QMimeType &other) const; - Returns true if \a other equals this QMimeType object, otherwise returns false. + Returns \c true if \a other equals this QMimeType object, otherwise returns \c false. The name is the unique identifier for a mimetype, so two mimetypes with the same name, are equal. */ @@ -188,12 +188,12 @@ bool QMimeType::operator==(const QMimeType &other) const /*! \fn bool QMimeType::operator!=(const QMimeType &other) const; - Returns true if \a other does not equal this QMimeType object, otherwise returns false. + Returns \c true if \a other does not equal this QMimeType object, otherwise returns \c false. */ /*! \fn bool QMimeType::isValid() const; - Returns true if the QMimeType object contains valid data, otherwise returns false. + Returns \c true if the QMimeType object contains valid data, otherwise returns \c false. A valid MIME type has a non-empty name(). The invalid MIME type is the default-constructed QMimeType. */ @@ -204,7 +204,7 @@ bool QMimeType::isValid() const /*! \fn bool QMimeType::isDefault() const; - Returns true if this MIME type is the default MIME type which + Returns \c true if this MIME type is the default MIME type which applies to all files: application/octet-stream. */ bool QMimeType::isDefault() const @@ -432,7 +432,7 @@ QString QMimeType::filterString() const /*! \fn bool QMimeType::inherits(const QString &mimeTypeName) const; - Returns true if this mimetype is \a mimeTypeName, + Returns \c true if this mimetype is \a mimeTypeName, or inherits \a mimeTypeName (see parentMimeTypes()), or \a mimeTypeName is an alias for this mimetype. */ -- cgit v1.2.3