summaryrefslogtreecommitdiffstats
path: root/src/corelib/io/qsettings.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/qsettings.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/qsettings.cpp')
-rw-r--r--src/corelib/io/qsettings.cpp10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/corelib/io/qsettings.cpp b/src/corelib/io/qsettings.cpp
index ebcaf062e3..c78b355ac1 100644
--- a/src/corelib/io/qsettings.cpp
+++ b/src/corelib/io/qsettings.cpp
@@ -1714,7 +1714,7 @@ break_out_of_outer_loop:
}
/*
- Returns false on parse error. However, as many keys are read as
+ Returns \c false on parse error. However, as many keys are read as
possible, so if the user doesn't check the status he will get the
most out of the file anyway.
*/
@@ -3181,8 +3181,8 @@ QStringList QSettings::childGroups() const
}
/*!
- Returns true if settings can be written using this QSettings
- object; returns false otherwise.
+ Returns \c true if settings can be written using this QSettings
+ object; returns \c false otherwise.
One reason why isWritable() might return false is if
QSettings operates on a read-only file.
@@ -3267,7 +3267,7 @@ void QSettings::remove(const QString &key)
}
/*!
- Returns true if there exists a setting called \a key; returns
+ Returns \c true if there exists a setting called \a key; returns
false otherwise.
If a group is set using beginGroup(), \a key is taken to be
@@ -3301,7 +3301,7 @@ void QSettings::setFallbacksEnabled(bool b)
}
/*!
- Returns true if fallbacks are enabled; returns false otherwise.
+ Returns \c true if fallbacks are enabled; returns \c false otherwise.
By default, fallbacks are enabled.