aboutsummaryrefslogtreecommitdiff
path: root/src/kconfig_compiler/README.dox
diff options
context:
space:
mode:
authorFriedrich W. H. Kossebau <kossebau@kde.org>2019-03-06 13:43:56 +0100
committerFriedrich W. H. Kossebau <kossebau@kde.org>2019-03-15 06:55:13 +0100
commita3ed87ca7808363d8752f919617f88010ebf46b3 (patch)
tree8499bdc6b25490d84e71b4bee3f2be5b159df6f6 /src/kconfig_compiler/README.dox
parent516f558742dfa8da7a5e6def39309516d703bc1b (diff)
downloadkconfig-a3ed87ca7808363d8752f919617f88010ebf46b3.tar.gz
kconfig-a3ed87ca7808363d8752f919617f88010ebf46b3.tar.bz2
kconfig_compiler: new kcfgc args HeaderExtension & SourceExtension
Summary: When using kconfig_compiler generated sources in projects where the used file extensions for C++ files are not ".h" and/or ".cpp", the include for the generated header looks a bit alien to the project, as well as the generated source file if one looks closer at it. This code adds new optional flags HeaderExtension & SourceExtension which can be used to control the file extensions used for the generated files. Test Plan: All unit tests and the new test_fileextensions pass, existing projects using kcfg without & with the new flags build fine. Reviewers: #frameworks, apol Reviewed By: apol Subscribers: apol, kde-frameworks-devel Tags: #frameworks Differential Revision: https://phabricator.kde.org/D19565
Diffstat (limited to 'src/kconfig_compiler/README.dox')
-rw-r--r--src/kconfig_compiler/README.dox12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/kconfig_compiler/README.dox b/src/kconfig_compiler/README.dox
index 3ba97285..64f7c44a 100644
--- a/src/kconfig_compiler/README.dox
+++ b/src/kconfig_compiler/README.dox
@@ -97,6 +97,18 @@ The following options are read from the kcfgc file:
<td>Name of kcfg file containing the options the class is generated for</td>
</tr>
<tr>
+ <td><b>HeaderExtension</b></td>
+ <td>string</td>
+ <td>h</td>
+ <td>Extension to use for the name of the generated C++ header files. Since KF 5.57</td>
+</tr>
+<tr>
+ <td><b>SourceExtension</b></td>
+ <td>string</td>
+ <td>cpp</td>
+ <td>Extension to use for the name of the generated C++ source file. Since KF 5.57</td>
+</tr>
+<tr>
<td><b>NameSpace</b></td>
<td>string</td>
<td>-</td>