summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNirbheek Chauhan <nirbheek@centricular.com>2018-04-15 13:12:59 +0530
committerNirbheek Chauhan <nirbheek@centricular.com>2018-04-15 14:03:47 +0530
commit0b4e54267f9f2c12b95ef2dc124e397eebae1e80 (patch)
treeae5d4df60539c84c0f11d4376ce2307aff7e0df7
parentd0b46afda8a4ea103d612300a5d558db2646178e (diff)
downloadmeson-nirbheek/gdbus-codegen-sources.tar.gz
docs: Update gnome.gdbus-codegen docsnirbheek/gdbus-codegen-sources
-rw-r--r--docs/markdown/Gnome-module.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/markdown/Gnome-module.md b/docs/markdown/Gnome-module.md
index 3db6cc035..0df59e185 100644
--- a/docs/markdown/Gnome-module.md
+++ b/docs/markdown/Gnome-module.md
@@ -227,9 +227,11 @@ useful when running the application locally for example during tests.
### gnome.gdbus_codegen()
Compiles the given XML schema into gdbus source code. Takes two
-positional arguments, the first one specifies the name of the source
-files and the second specifies the XML file name.
+positional arguments, the first one specifies the base name to use
+while creating the output source and header and the second specifies
+one XML file.
+* `sources`: list of XML files
* `interface_prefix`: prefix for the interface
* `namespace`: namespace of the interface
* `object_manager`: *(Added 0.40.0)* if true generates object manager code
@@ -238,6 +240,9 @@ files and the second specifies the XML file name.
* `build_by_default`: causes, when set to true, to have this target be
built by default, that is, when invoking plain `ninja`, the default
value is true for all built target types
+* `depend_files`: files ([`string`](#string-object),
+ [`files()`](#files), or [`configure_file()`](#configure_file)) of
+ XML files that should trigger a re-compile if changed.
* `install_dir`: (*Added 0.46.0*) location to install the header or
bundle depending on previous options
* `install_header`: (*Added 0.46.0*) if true, install the header file
@@ -257,7 +262,8 @@ Example:
gnome = import('gnome')
# The returned source would be passed to another target
-gdbus_src = gnome.gdbus_codegen('example-interface', 'com.example.Sample.xml',
+gdbus_src = gnome.gdbus_codegen('example-interface',
+ sources: 'com.example.Sample.xml',
interface_prefix : 'com.example.',
namespace : 'Sample',
annotations : [