aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2018-05-27 23:50:30 +0300
committerGitHub <noreply@github.com>2018-05-27 23:50:30 +0300
commitcc3e0bc4690886485e880b673ea16989f820b90d (patch)
tree9d589f534b83a5682df550e34a73ef7b1c498acc /docs/markdown
parent1ff15f527b4aeb05874a729e5bb1c143c8cf6768 (diff)
parent7cfe970cef7e913279b55f7b3261b53b7f2a50a1 (diff)
downloadmeson-cc3e0bc4690886485e880b673ea16989f820b90d.zip
meson-cc3e0bc4690886485e880b673ea16989f820b90d.tar.gz
meson-cc3e0bc4690886485e880b673ea16989f820b90d.tar.bz2
Merge pull request #3491 from jeandet/qt_private_headers
Qt private headers
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Qt5-module.md8
-rw-r--r--docs/markdown/Reference-manual.md1
2 files changed, 9 insertions, 0 deletions
diff --git a/docs/markdown/Qt5-module.md b/docs/markdown/Qt5-module.md
index b5393a8..0185a64 100644
--- a/docs/markdown/Qt5-module.md
+++ b/docs/markdown/Qt5-module.md
@@ -20,6 +20,7 @@ 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).
+## Example
A simple example would look like this:
```meson
@@ -38,3 +39,10 @@ executable('myprog', 'main.cpp', 'myclass.cpp', moc_files,
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
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 804ca0f..2f45451 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -347,6 +347,7 @@ otherwise. This function supports the following keyword arguments:
`>1.0.0`, `<=2.3.5` or `3.1.4` for exact matching. (*Added 0.37.0*)
You can also specify multiple restrictions by passing a list to this
keyword argument, such as: `['>=3.14.0', '<=4.1.0']`.
+- `private_headers`, only available with Qt modules see [documentation](Qt5-module.md#private_headers).
If dependency_name is '', the dependency is always not found. So with
`required: false`, this always returns a dependency object for which the