aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorLeif Middelschulte <leif.middelschulte@gmail.com>2017-10-24 10:05:26 +0200
committerLeif Middelschulte <leif.middelschulte@gmail.com>2017-10-25 21:09:16 +0200
commit050a56ad47fef8f8fbc66a6b3465bd49697bef94 (patch)
tree9512641533b0329e94895d518d2fe75bf0421f49 /docs/markdown
parent14e7b0af25c90ed78b9309fd122d34b24d69fc0e (diff)
downloadmeson-050a56ad47fef8f8fbc66a6b3465bd49697bef94.zip
meson-050a56ad47fef8f8fbc66a6b3465bd49697bef94.tar.gz
meson-050a56ad47fef8f8fbc66a6b3465bd49697bef94.tar.bz2
Qt5-Module: Add `moc_extra_arguments` keyword support.
This commit adds support for an additional `moc_extra_arguments` keyword. It becomes especially handy, when `moc`-ed sources conditionally provide `slots`, depending on compile time macros (i.e. defines).
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Qt5-module.md10
-rw-r--r--docs/markdown/snippets/qt5-moc_extra_arguments.md8
2 files changed, 13 insertions, 5 deletions
diff --git a/docs/markdown/Qt5-module.md b/docs/markdown/Qt5-module.md
index a8ad73d..613e5c1 100644
--- a/docs/markdown/Qt5-module.md
+++ b/docs/markdown/Qt5-module.md
@@ -5,11 +5,11 @@ tools and steps required for Qt. The module has one method.
## preprocess
-This method takes five keyword arguments, `moc_headers`,
-`moc_sources`, `ui_files` and `qresources` which define the files that
-require preprocessing with `moc`, `uic` and `rcc` and 'include_directories' which might be needed by moc. It returns an
-opaque object that should be passed to a main build target. A simple
-example would look like this:
+This method takes six keyword arguments, `moc_headers`, `moc_sources`, `ui_files`, `qresources`
+and `moc_extra_arguments` which define the files that require preprocessing with `moc`, `uic`
+and `rcc` and 'include_directories' which might be needed by moc as well as (optional)
+additional arguments. It returns an opaque object that should be passed to a main build target.
+A simple example would look like this:
```meson
qt5 = import('qt5')
diff --git a/docs/markdown/snippets/qt5-moc_extra_arguments.md b/docs/markdown/snippets/qt5-moc_extra_arguments.md
new file mode 100644
index 0000000..957c3c7
--- /dev/null
+++ b/docs/markdown/snippets/qt5-moc_extra_arguments.md
@@ -0,0 +1,8 @@
+# Adds support for additional Qt5-Module keyword `moc_extra_arguments`
+
+When `moc`-ing sources, the `moc` tool does not know about any
+preprocessor macros. The generated code might not match the input
+files when the linking with the moc input sources happens.
+
+This amendment allows to specify a a list of additional arguments
+passed to the `moc` tool. They are called `moc_extra_arguments`. \ No newline at end of file