summaryrefslogtreecommitdiffstats
path: root/src/corelib/io/qresource.cpp
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-02 16:51:05 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-08 00:46:27 +0200
commit4533cc994484a2308297e64e99af005fb4dca065 (patch)
treebc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/corelib/io/qresource.cpp
parent50dd0232b61d8ea3fb9aab18972c6e19678656e6 (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/corelib/io/qresource.cpp')
-rw-r--r--src/corelib/io/qresource.cpp24
1 files changed, 12 insertions, 12 deletions
diff --git a/src/corelib/io/qresource.cpp b/src/corelib/io/qresource.cpp
index 04ec81e159..c16b8d79a2 100644
--- a/src/corelib/io/qresource.cpp
+++ b/src/corelib/io/qresource.cpp
@@ -451,7 +451,7 @@ QString QResource::absoluteFilePath() const
}
/*!
- Returns true if the resource really exists in the resource hierarchy,
+ Returns \c true if the resource really exists in the resource hierarchy,
false otherwise.
*/
@@ -466,7 +466,7 @@ bool QResource::isValid() const
/*!
\fn bool QResource::isFile() const
- Returns true if the resource represents a file and thus has data
+ Returns \c true if the resource represents a file and thus has data
backing it, false if it represents a directory.
\sa isDir()
@@ -474,7 +474,7 @@ bool QResource::isValid() const
/*!
- Returns true if the resource represents a file and the data backing it
+ Returns \c true if the resource represents a file and the data backing it
is in a compressed format, false otherwise.
\sa data(), isFile()
@@ -517,7 +517,7 @@ const uchar *QResource::data() const
}
/*!
- Returns true if the resource represents a directory and thus may have
+ Returns \c true if the resource represents a directory and thus may have
children() in it, false if it represents a file.
\sa isFile()
@@ -1044,8 +1044,8 @@ static QString qt_resource_fixResourceRoot(QString r) {
\fn bool QResource::registerResource(const QString &rccFileName, const QString &mapRoot)
Registers the resource with the given \a rccFileName at the location in the
- resource tree specified by \a mapRoot, and returns true if the file is
- successfully opened; otherwise returns false.
+ resource tree specified by \a mapRoot, and returns \c true if the file is
+ successfully opened; otherwise returns \c false.
\sa unregisterResource()
*/
@@ -1075,9 +1075,9 @@ QResource::registerResource(const QString &rccFilename, const QString &resourceR
\fn bool QResource::unregisterResource(const QString &rccFileName, const QString &mapRoot)
Unregisters the resource with the given \a rccFileName at the location in
- the resource tree specified by \a mapRoot, and returns true if the
+ the resource tree specified by \a mapRoot, and returns \c true if the
resource is successfully unloaded and no references exist for the
- resource; otherwise returns false.
+ resource; otherwise returns \c false.
\sa registerResource()
*/
@@ -1112,8 +1112,8 @@ QResource::unregisterResource(const QString &rccFilename, const QString &resourc
\since 4.3
Registers the resource with the given \a rccData at the location in the
- resource tree specified by \a mapRoot, and returns true if the file is
- successfully opened; otherwise returns false.
+ resource tree specified by \a mapRoot, and returns \c true if the file is
+ successfully opened; otherwise returns \c false.
\warning The data must remain valid throughout the life of any QFile
that may reference the resource data.
@@ -1147,8 +1147,8 @@ QResource::registerResource(const uchar *rccData, const QString &resourceRoot)
\since 4.3
Unregisters the resource with the given \a rccData at the location in the
- resource tree specified by \a mapRoot, and returns true if the resource is
- successfully unloaded and no references exist into the resource; otherwise returns false.
+ resource tree specified by \a mapRoot, and returns \c true if the resource is
+ successfully unloaded and no references exist into the resource; otherwise returns \c false.
\sa registerResource()
*/