From d1edad3cc4de378e0065933f3bbdce692678a381 Mon Sep 17 00:00:00 2001 From: "Friedrich W. H. Kossebau" Date: Fri, 24 Jul 2020 18:49:01 +0200 Subject: API dox: state explicitly expected encoding for KConfig key & group names While the API might have been once designed to allow random byte strings to be used as ids and only converted QString to UTF-8, the current implementation in many places assumes the byte strings passed via const char* or QByteArray are also in of UTF-8 encoding (or at least ASCII7-only). See e.g. KConfigGroup::entryMap() or KConfigGroup::name(). Stating the supported encoding explicitly should avoid any misassumptions. --- src/core/kconfigwatcher.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/core/kconfigwatcher.h') diff --git a/src/core/kconfigwatcher.h b/src/core/kconfigwatcher.h index 75612831..28576bb4 100644 --- a/src/core/kconfigwatcher.h +++ b/src/core/kconfigwatcher.h @@ -50,7 +50,7 @@ Q_SIGNALS: * The config will be reloaded before this signal is emitted * * @arg group the config group that has changed - * @arg names a list of entries that have changed within that group + * @arg names a list of entries that have changed within that group (UTF-8 encoded) */ void configChanged(const KConfigGroup &group, const QByteArrayList &names); -- cgit v1.2.1