summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJon Turney <jon.turney@dronecode.org.uk>2018-05-31 12:49:39 +0100
committerNirbheek Chauhan <nirbheek.chauhan@gmail.com>2018-05-31 13:15:47 +0000
commit0092e6d9086db04627be798ccb0467c32289b733 (patch)
tree5d5ca7cf5ad6e0b438e1838f0cdafac8665e1adc
parent809336833cbc5cec2656f32d03e9221fc5406cb3 (diff)
downloadmeson-0092e6d9086db04627be798ccb0467c32289b733.tar.gz
Mention private_headers keyword in Qt dependency documentation [skip ci]
Also, put discussion of Qt dependencies *before* the example in the Qt5 module documentation.
-rw-r--r--docs/markdown/Dependencies.md6
-rw-r--r--docs/markdown/Qt5-module.md21
2 files changed, 16 insertions, 11 deletions
diff --git a/docs/markdown/Dependencies.md b/docs/markdown/Dependencies.md
index ca874d0b1..d2b5e0af9 100644
--- a/docs/markdown/Dependencies.md
+++ b/docs/markdown/Dependencies.md
@@ -223,6 +223,12 @@ the list of sources for the target. The `modules` keyword of
`dependency` works just like it does with Boost. It tells which
subparts of Qt the program uses.
+Setting the optional `private_headers` keyword to true adds the private header
+include path of the given module(s) to the compiler flags. (since v0.47.0)
+
+**Note** using private headers in your project is a bad idea, do so at your own
+risk.
+
## SDL2
SDL2 can be located using `pkg-confg`, the `sdl2-config` config tool, or as an
diff --git a/docs/markdown/Qt5-module.md b/docs/markdown/Qt5-module.md
index 0185a64dc..46fbd84c1 100644
--- a/docs/markdown/Qt5-module.md
+++ b/docs/markdown/Qt5-module.md
@@ -20,6 +20,16 @@ This method generates the necessary targets to build translation files with lrel
- `install_dir` directory to install to (optional).
- `build_by_default` when set to true, to have this target be built by default, that is, when invoking plain ninja; the default value is false (optional).
+## Dependencies
+
+See [Qt dependencies](Dependencies.md#qt4-qt5)
+
+The 'modules' argument is used to include Qt modules in the project.
+See the Qt documentation for the [list of modules](http://doc.qt.io/qt-5/qtmodules.html).
+
+The 'private_headers' argument allows usage of Qt's modules private headers.
+(since v0.47.0)
+
## Example
A simple example would look like this:
@@ -35,14 +45,3 @@ executable('myprog', 'main.cpp', 'myclass.cpp', moc_files,
include_directories: inc,
dependencies : qt5_dep)
```
-
-
-The 'modules' argument is used to include Qt modules in the project.
-See the Qt documentation for the [list of modules](http://doc.qt.io/qt-5/qtmodules.html).
-
-## private headers (since v0.47.0)
-
-**private_headers** keyword argument has been added to [dependency](Reference-manual.md#dependency) method to allow Qt's modules private headers usage.
-Setting this optional argument to true will add private include path of the given module to the compiler flags.
-
-**Note** that using private headers in your project is a bad idea, do it at your own risks. \ No newline at end of file