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/corelib/plugin/qpluginloader.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/corelib/plugin/qpluginloader.cpp')
| -rw-r--r-- | src/corelib/plugin/qpluginloader.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
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() */ |