diff options
| -rw-r--r-- | src/kconfig_compiler/README.dox | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/src/kconfig_compiler/README.dox b/src/kconfig_compiler/README.dox index e11b157b..15aa73c3 100644 --- a/src/kconfig_compiler/README.dox +++ b/src/kconfig_compiler/README.dox @@ -1,9 +1,9 @@ /** \page kconfig_compiler The KDE Configuration Compiler -kconfig_compiler generates C++ source code from an XML file containing -information about configuration options (.kcfg) and a file that provides -the code generation options (.kcfgc) The generated class is based on +kconfig_compiler generates C++ source code from an XML file containing +information about configuration options (.kcfg) and a file that provides +the code generation options (.kcfgc) The generated class is based on KConfigSkeleton and provides an API for the application to access its configuration data. @@ -26,7 +26,7 @@ are needed to compile the code needed to compute default values. To generate a \#include "..." statement instead of \#include \<...\>, enclose the header file name in double quotes (e.g. \<include\>"header.h"\</include\>). -The remaining entries in the XML file are grouped by the tag \<group\> +The remaining entries in the XML file are grouped by the tag \<group\> which describes the corresponding group in the configuration file. The individual entries must have at least a name or a key. The key is used @@ -41,10 +41,10 @@ by the QVariant with exception of the clearly binary types (e.g. Pixmap, Image...) which are not supported. Besides those basic types the following special types are supported: -- Path This is a string that is specially treated as a file-path. +- Path This is a string that is specially treated as a file-path. In particular paths in the home directory are prefixed with $HOME in when being stored in the configuration file. - + - Enum This indicates an enumeration. The possible enum values and optional enum name should be provided via the \<choices\> tag. Enum values are accessed as integers by the application but stored as strings in the @@ -118,7 +118,7 @@ The following options are read from the kcfgc file: <td><b>Visibility</b></td> <td>string</td> <td>-</td> - <td>Inserts visibility directive (for example KDE_EXPORT) between "class" keyword and class + <td>Inserts visibility directive (for example KDE_EXPORT) between "class" keyword and class name in header file</td> </tr> <tr> @@ -162,7 +162,7 @@ The following options are read from the kcfgc file: <td>false</td> <td>If true, mutator functions for all configuration options are generated. If false, no mutator functions are generated. If a list is provided, - mutator functions are generated for the options that are listed.</td> + mutator functions are generated for the options that are listed.</td> </tr> <tr> <td><b>DefaultValueGetters</b></td> @@ -170,7 +170,7 @@ The following options are read from the kcfgc file: <td>false</td> <td>If true, functions to return the default value of all configuration options are generated. If false, no default value functions are generated. If a list - is provided, default value functions are generated for the options that are listed.</td> + is provided, default value functions are generated for the options that are listed.</td> </tr> <tr> <td><b>ItemAccessors</b></td> @@ -269,7 +269,7 @@ color_3=#ffff00 \endverbatim The configuration options will be accessible to the application via -a QColor color(int ColorIndex) and a +a QColor color(int ColorIndex) and a void setColor(int ColorIndex, const QColor &v) function. Example 2: @@ -295,7 +295,7 @@ sound_Crash=crash.wav sound_Missile=missile.wav The configuration options will be accessible to the application via -a QString sound(int SoundEvent) and a +a QString sound(int SoundEvent) and a void setSound(int SoundEvent, const QString &v) function. - Parameterized groups |