aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2021-10-29 22:45:04 +0300
committerGitHub <noreply@github.com>2021-10-29 22:45:04 +0300
commitaf85738dafc8b371c8b6dbcfba23e1cdb621dc8c (patch)
treeec0996a81a0a237080b9c674284b47426f3f28c9 /docs/markdown
parent7a12c911bf5478b0a762432985535a6a823b13ab (diff)
parent6849baa47633d2986c049cd68916bc9ce95ba2d0 (diff)
downloadmeson-af85738dafc8b371c8b6dbcfba23e1cdb621dc8c.zip
meson-af85738dafc8b371c8b6dbcfba23e1cdb621dc8c.tar.gz
meson-af85738dafc8b371c8b6dbcfba23e1cdb621dc8c.tar.bz2
Merge pull request #9375 from dcbaker/submit/windows-module-typing
Typing for the Windows module
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Windows-module.md18
-rw-r--r--docs/markdown/snippets/windows_custom_targets.md22
2 files changed, 37 insertions, 3 deletions
diff --git a/docs/markdown/Windows-module.md b/docs/markdown/Windows-module.md
index a7131a7..06b3eb2 100644
--- a/docs/markdown/Windows-module.md
+++ b/docs/markdown/Windows-module.md
@@ -7,10 +7,22 @@ Windows.
### compile_resources
+```
+ windows.compile_resources(...(string | File | CustomTarget | CustomTargetIndex),
+ args: []string,
+ depend_files: [](string | File),
+ depends: [](BuildTarget | CustomTarget)
+ include_directories: [](IncludeDirectories | string)): []CustomTarget
+```
+
Compiles Windows `rc` files specified in the positional arguments.
-Returns an opaque object that you put in the list of sources for the
-target you want to have the resources in. This method has the
-following keyword argument.
+Returns a list of `CustomTarget` objects that you put in the list of sources for
+the target you want to have the resources in.
+
+*Since 0.61.0* CustomTargetIndexs and CustomTargets with more than out output
+*may be used as positional arguments.
+
+This method has the following keyword arguments:
- `args` lists extra arguments to pass to the resource compiler
- `depend_files` lists resource files that the resource script depends on
diff --git a/docs/markdown/snippets/windows_custom_targets.md b/docs/markdown/snippets/windows_custom_targets.md
new file mode 100644
index 0000000..cbc2f9d
--- /dev/null
+++ b/docs/markdown/snippets/windows_custom_targets.md
@@ -0,0 +1,22 @@
+## Windows.compile_resources CustomTarget
+
+Previously the Windows module only accepted CustomTargets with one output, it
+now accepts them with more than one output, and creates a windows resource
+target for each output. Additionally it now accepts indexes of CustomTargets
+
+```meson
+
+ct = custom_target(
+ 'multiple',
+ output : ['resource', 'another resource'],
+ ...
+)
+
+ct2 = custom_target(
+ 'slice',
+ output : ['resource', 'not a resource'],
+ ...
+)
+
+resources = windows.compile_resources(ct, ct2[0])
+```