summaryrefslogtreecommitdiffstats
path: root/src/corelib/plugin
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/plugin
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/plugin')
-rw-r--r--src/corelib/plugin/qlibrary.cpp16
-rw-r--r--src/corelib/plugin/qpluginloader.cpp10
-rw-r--r--src/corelib/plugin/quuid.cpp24
3 files changed, 25 insertions, 25 deletions
diff --git a/src/corelib/plugin/qlibrary.cpp b/src/corelib/plugin/qlibrary.cpp
index 92e60c2216..77de4d594e 100644
--- a/src/corelib/plugin/qlibrary.cpp
+++ b/src/corelib/plugin/qlibrary.cpp
@@ -223,7 +223,7 @@ static long qt_find_pattern(const char *s, ulong s_len,
we can get the verification data without have to actually load the library.
This lets us detect mismatches more safely.
- Returns false if version information is not present, or if the
+ Returns \c false if version information is not present, or if the
information could not be read.
Returns true if version information is present and successfully read.
*/
@@ -560,8 +560,8 @@ bool QLibraryPrivate::loadPlugin()
}
/*!
- Returns true if \a fileName has a valid suffix for a loadable
- library; otherwise returns false.
+ Returns \c true if \a fileName has a valid suffix for a loadable
+ library; otherwise returns \c false.
\table
\header \li Platform \li Valid suffixes
@@ -736,8 +736,8 @@ void QLibraryPrivate::updatePluginState()
}
/*!
- Loads the library and returns true if the library was loaded
- successfully; otherwise returns false. Since resolve() always
+ Loads the library and returns \c true if the library was loaded
+ successfully; otherwise returns \c false. Since resolve() always
calls this function before resolving any symbols it is not
necessary to call it explicitly. In some situations you might want
the library loaded in advance, in which case you would use this
@@ -756,8 +756,8 @@ bool QLibrary::load()
}
/*!
- Unloads the library and returns true if the library could be
- unloaded; otherwise returns false.
+ Unloads the library and returns \c true if the library could be
+ unloaded; otherwise returns \c false.
This happens automatically on application termination, so you
shouldn't normally need to call this function.
@@ -780,7 +780,7 @@ bool QLibrary::unload()
}
/*!
- Returns true if the library is loaded; otherwise returns false.
+ Returns \c true if the library is loaded; otherwise returns \c false.
\sa load()
*/
diff --git a/src/corelib/plugin/qpluginloader.cpp b/src/corelib/plugin/qpluginloader.cpp
index ded4f6bfa2..e4a1d725ec 100644
--- a/src/corelib/plugin/qpluginloader.cpp
+++ b/src/corelib/plugin/qpluginloader.cpp
@@ -219,8 +219,8 @@ QJsonObject QPluginLoader::metaData() const
}
/*!
- Loads the plugin and returns true if the plugin was loaded
- successfully; otherwise returns false. Since instance() always
+ Loads the plugin and returns \c true if the plugin was loaded
+ successfully; otherwise returns \c false. Since instance() always
calls this function before resolving any symbols it is not
necessary to call it explicitly. In some situations you might want
the plugin loaded in advance, in which case you would use this
@@ -242,8 +242,8 @@ bool QPluginLoader::load()
/*!
- Unloads the plugin and returns true if the plugin could be
- unloaded; otherwise returns false.
+ Unloads the plugin and returns \c true if the plugin could be
+ unloaded; otherwise returns \c false.
This happens automatically on application termination, so you
shouldn't normally need to call this function.
@@ -269,7 +269,7 @@ bool QPluginLoader::unload()
}
/*!
- Returns true if the plugin is loaded; otherwise returns false.
+ Returns \c true if the plugin is loaded; otherwise returns \c false.
\sa load()
*/
diff --git a/src/corelib/plugin/quuid.cpp b/src/corelib/plugin/quuid.cpp
index 4de83c62ee..183a16a7ad 100644
--- a/src/corelib/plugin/quuid.cpp
+++ b/src/corelib/plugin/quuid.cpp
@@ -512,15 +512,15 @@ QUuid QUuid::fromRfc4122(const QByteArray &bytes)
/*!
\fn bool QUuid::operator==(const QUuid &other) const
- Returns true if this QUuid and the \a other QUuid are identical;
- otherwise returns false.
+ Returns \c true if this QUuid and the \a other QUuid are identical;
+ otherwise returns \c false.
*/
/*!
\fn bool QUuid::operator!=(const QUuid &other) const
- Returns true if this QUuid and the \a other QUuid are different;
- otherwise returns false.
+ Returns \c true if this QUuid and the \a other QUuid are different;
+ otherwise returns \c false.
*/
/*!
@@ -735,8 +735,8 @@ QDataStream &operator>>(QDataStream &s, QUuid &id)
#endif // QT_NO_DATASTREAM
/*!
- Returns true if this is the null UUID
- {00000000-0000-0000-0000-000000000000}; otherwise returns false.
+ Returns \c true if this is the null UUID
+ {00000000-0000-0000-0000-000000000000}; otherwise returns \c false.
*/
bool QUuid::isNull() const
{
@@ -823,7 +823,7 @@ QUuid::Version QUuid::version() const
/*!
\fn bool QUuid::operator<(const QUuid &other) const
- Returns true if this QUuid has the same \l{Variant field}
+ Returns \c true if this QUuid has the same \l{Variant field}
{variant field} as the \a other QUuid and is lexicographically
\e{before} the \a other QUuid. If the \a other QUuid has a
different variant field, the return value is determined by
@@ -849,7 +849,7 @@ bool QUuid::operator<(const QUuid &other) const
/*!
\fn bool QUuid::operator>(const QUuid &other) const
- Returns true if this QUuid has the same \l{Variant field}
+ Returns \c true if this QUuid has the same \l{Variant field}
{variant field} as the \a other QUuid and is lexicographically
\e{after} the \a other QUuid. If the \a other QUuid has a
different variant field, the return value is determined by
@@ -992,15 +992,15 @@ QUuid QUuid::createUuid()
/*!
\fn bool QUuid::operator==(const GUID &guid) const
- Returns true if this UUID is equal to the Windows GUID \a guid;
- otherwise returns false.
+ Returns \c true if this UUID is equal to the Windows GUID \a guid;
+ otherwise returns \c false.
*/
/*!
\fn bool QUuid::operator!=(const GUID &guid) const
- Returns true if this UUID is not equal to the Windows GUID \a
- guid; otherwise returns false.
+ Returns \c true if this UUID is not equal to the Windows GUID \a
+ guid; otherwise returns \c false.
*/
#ifndef QT_NO_DEBUG_STREAM