aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHarald Sitter <sitter@kde.org>2018-09-17 15:44:11 +0200
committerHarald Sitter <sitter@kde.org>2018-09-17 17:19:19 +0200
commit39cdcdf6c1d503d0c72da3a854195af393dd0fae (patch)
treefbd5aa5f1e974fe7e7f44356df9c8717de08e702
parent15ab4ca9678b3cf6d5cc67f6fca62d85dbee5c83 (diff)
downloadkconfig-39cdcdf6c1d503d0c72da3a854195af393dd0fae.tar.gz
kconfig-39cdcdf6c1d503d0c72da3a854195af393dd0fae.tar.bz2
kcfg_compiler now documents valid inputs for its 'Color' type
Summary: it wasn't exactly clear what the inputs for a Color type may be. this is now explained along with special type descriptions. it isn't perfectly ideal here since it is a bit hard to find, but better be hard to find than not documented at all. from a quick glance at the code indeed anything goes that QColor can construct from a QString. there is also custom regex code in the compiler that allows construction from r,g,b,a via the appropriate ctor of qcolor. Reviewers: broulik Reviewed By: broulik Subscribers: broulik, kde-frameworks-devel Tags: #frameworks Differential Revision: https://phabricator.kde.org/D15576
-rw-r--r--src/kconfig_compiler/README.dox5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/kconfig_compiler/README.dox b/src/kconfig_compiler/README.dox
index 15aa73c3..f6aff230 100644
--- a/src/kconfig_compiler/README.dox
+++ b/src/kconfig_compiler/README.dox
@@ -55,6 +55,11 @@ types the following special types are supported:
to the application as QValueList<int>. Useful for storing QSplitter
geometries.
+- Color isn't a special type but has special input. It is generated as QColor.
+ Any valid input to QColor(QString) can be used (hex or SVG keyword notation)
+ as well as a special format r,g,b,a where the a denotes the alpha channel and
+ may be omitted.
+
An entry can optionally have a default value which is used as default when
the value isn't specified in any config file. Default values are interpreted
as literal constant values. If a default value needs to be computed