Mention private_headers keyword in Qt dependency documentation [skip ci]

Also, put discussion of Qt dependencies *before* the example in the Qt5
module documentation.
pull/3652/head
Jon Turney 7 years ago committed by Nirbheek Chauhan
parent 809336833c
commit 0092e6d908
  1. 6
      docs/markdown/Dependencies.md
  2. 21
      docs/markdown/Qt5-module.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

@ -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.
Loading…
Cancel
Save