diff options
| author | Patrick Griffis <tingping@tingping.se> | 2017-05-02 14:14:04 -0400 |
|---|---|---|
| committer | Jussi Pakkanen <jpakkane@gmail.com> | 2017-05-02 22:14:39 +0300 |
| commit | a6775233c7b2d59cfa5fb5048803c6d0dbb1539d (patch) | |
| tree | 3dd27c248173f5bb10fcc1a48fc500b9ae606cfd | |
| parent | 9d69c934d62e3239157d4e87e03b4c851210dc53 (diff) | |
| download | meson-a6775233c7b2d59cfa5fb5048803c6d0dbb1539d.zip meson-a6775233c7b2d59cfa5fb5048803c6d0dbb1539d.tar.gz meson-a6775233c7b2d59cfa5fb5048803c6d0dbb1539d.tar.bz2 | |
docs: Document missing gnome.compile_resources() kwargs
| -rw-r--r-- | docs/markdown/Gnome-module.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/markdown/Gnome-module.md b/docs/markdown/Gnome-module.md index af1e059..827568a 100644 --- a/docs/markdown/Gnome-module.md +++ b/docs/markdown/Gnome-module.md @@ -12,13 +12,19 @@ To use this module, just do: **`gnome = import('gnome')`**. The following functi ### gnome.compile_resources() -This function compiles resources specified in an XML file into code that can be embedded inside the main binary. Similar a build target it takes two positional arguments. The first one is the name of the resource and the second is the xml file containing the resource definitions. If the name is `foobar`, Meson will generate a header file called `foobar.h`, which you can then include in your sources. There are two keyword arguments. +This function compiles resources specified in an XML file into code that can be embedded inside the main binary. Similar a build target it takes two positional arguments. The first one is the name of the resource and the second is the xml file containing the resource definitions. If the name is `foobar`, Meson will generate a header file called `foobar.h`, which you can then include in your sources. * `source_dir`: a list of subdirectories where the resource compiler should look up the files, relative to the location of the xml file * `c_name`: passed to the resource compiler as an argument after `--c-name` +* `dependencies`: extra targets to depend upon for building +* `export`: (*Added 0.37.0*) if true, export the symbols of the generated sources +* `gresource_bundle`: (*Added 0.37.0*) if true, output a `.gresource` file instead of source +* `install_header`: (*Added 0.37.0*) if true, install the header file +* `install`: (*Added 0.37.0*) if true, install the gresource file +* `install_dir`: (*Added 0.37.0*) location to install the header or bundle depending on previous options * `extra_args`: extra command line arguments to pass to the resource compiler -Returns an array of two elements which are: `[c_source, header_file]` +Returns an array containing: `[c_source, header_file]` or `[gresource_bundle]` ### gnome.generate_gir() |