diff options
| author | Leif Middelschulte <leif.middelschulte@gmail.com> | 2017-10-27 08:38:15 +0200 |
|---|---|---|
| committer | Leif Middelschulte <leif.middelschulte@gmail.com> | 2017-10-27 08:38:15 +0200 |
| commit | a46d05acf9dda6f2e5f06254a6da6652646a820e (patch) | |
| tree | 9e2f44ee25fde9fbe9c6b8e82ce44a720a51cefe /docs/markdown/Qt5-module.md | |
| parent | b919e0582178fc39b56efbbf0dc66eb949badc0c (diff) | |
| download | meson-a46d05acf9dda6f2e5f06254a6da6652646a820e.zip meson-a46d05acf9dda6f2e5f06254a6da6652646a820e.tar.gz meson-a46d05acf9dda6f2e5f06254a6da6652646a820e.tar.bz2 | |
updates the documentation to follow the list-style to explain arguments.
As per to @jon-turney's and @jpakanne's suggestion [0], this commit
changes the "prosa" documentation to a list-style one.
[0] https://github.com/mesonbuild/meson/pull/2529#pullrequestreview-72265697
Diffstat (limited to 'docs/markdown/Qt5-module.md')
| -rw-r--r-- | docs/markdown/Qt5-module.md | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/markdown/Qt5-module.md b/docs/markdown/Qt5-module.md index 613e5c1..e84b5fd 100644 --- a/docs/markdown/Qt5-module.md +++ b/docs/markdown/Qt5-module.md @@ -5,10 +5,13 @@ tools and steps required for Qt. The module has one method. ## preprocess -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. +This method takes the following keyword arguments: + - `moc_headers`, `moc_sources`, `ui_files`, `qresources`, which define the files that require preprocessing with `moc`, `uic` and `rcc` + - `include_directories`, the directories to add to header search path for `moc` (optional) + - `moc_extra_arguments`, any additional arguments to `moc` (optional). + +It returns an opaque object that should be passed to a main build target. + A simple example would look like this: ```meson |