diff options
| author | Friedrich W. H. Kossebau <kossebau@kde.org> | 2020-07-24 18:49:01 +0200 |
|---|---|---|
| committer | Friedrich W. H. Kossebau <kossebau@kde.org> | 2020-07-25 00:51:44 +0200 |
| commit | d1edad3cc4de378e0065933f3bbdce692678a381 (patch) | |
| tree | 3e201ad2f14829b05e43da39f67808b4287dc7bc /src/core/kconfigwatcher.h | |
| parent | f0cf93864bd7b72377aebead108dd0da8749ba93 (diff) | |
| download | kconfig-d1edad3cc4de378e0065933f3bbdce692678a381.tar.gz kconfig-d1edad3cc4de378e0065933f3bbdce692678a381.tar.bz2 | |
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.
Diffstat (limited to 'src/core/kconfigwatcher.h')
| -rw-r--r-- | src/core/kconfigwatcher.h | 2 |
1 files changed, 1 insertions, 1 deletions
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); |