luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-28 10:06:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

gdbus-codegen: Improve documentation

Browse Source 
Recent changes has extended the functionality of `gdbus-codegen`
by implementing new options.

This patch extends the documentation including the behaviour of
the new options along the old ones.

(Wording tweaked by Philip Withnall before pushing.)

https://bugzilla.gnome.org/show_bug.cgi?id=791015
This commit is contained in:
Iñigo Martínez 2018-01-27 13:13:39 +01:00 committed by Philip Withnall
parent 93042e0052
commit 3ef83618d9
1 changed files with 27 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/reference/gio/gdbus-codegen.xml
View File

@ -67,9 +67,9 @@
url="http://dbus.freedesktop.org/doc/dbus-specification.html#introspection-format">D-Bus url="http://dbus.freedesktop.org/doc/dbus-specification.html#introspection-format">D-Bus
Introspection XML</ulink> from files passed as additional Introspection XML</ulink> from files passed as additional
arguments on the command line and generates output files. arguments on the command line and generates output files.
It currently supports generating C code (via It currently supports generating C source code (via
<option>--generate-c-code</option>) and Docbook XML (via <option>--body</option>) or header (via <option>--header</option>)
<option>--generate-docbook</option>). and Docbook XML (via <option>--generate-docbook</option>).
</para> </para>
</refsect1> </refsect1>
@ -88,6 +88,20 @@
#GDBusConnection either directly or via a #GDBusConnection either directly or via a
#GDBusObjectManagerServer instance. #GDBusObjectManagerServer instance.
</para> </para>
<para>
For C code generation either <option>--body</option> that
generates source code, or <option>--header</option> that
generates headers, can be used. These options must be used along with
<option>--output</option>, which is used to specify the file to output to.
</para>
<para>
Both files can be generated at the same time by using
<option>--generate-c-code</option>, but this option is deprecated.
In this case <option>--output</option> cannot be used due to the
generation of multiple files. Instead pass
<option>--output-directory</option> to specify the directory to put
the output files in. By default the current directory will be used.
</para>
<para> <para>
The name of each generated C type is derived from the D-Bus The name of each generated C type is derived from the D-Bus
interface name stripped with the prefix given with interface name stripped with the prefix given with
@ -188,6 +202,11 @@
<literal>NAME</literal> is a place-holder for the interface <literal>NAME</literal> is a place-holder for the interface
name, e.g. <literal>net.Corp.FooBar</literal> and so on. name, e.g. <literal>net.Corp.FooBar</literal> and so on.
</para> </para>
<para>
Pass <option>--output-directory</option> to specify the directory
to put the output files in. By default the current directory
will be used.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -262,6 +281,11 @@
<para> <para>
Directory to output generated source to. Equivalent to changing directory before generation. Directory to output generated source to. Equivalent to changing directory before generation.
</para> </para>
<para>
This option cannot be used with neither <option>--body</option> nor
<option>--header</option>, and <option>--output</option> must be used.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>