luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-12 15:36:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Document --symbol-decorator for gdbus-codegen

Browse Source 
This updates gdbus-codegen.xml to include documentation for the
--symbol-decorator, --symbol-decorator-header and
--symbol-decorator-define options, which is used to help to export
symbols in the generated code.
This commit is contained in:
Chun-wei Fan 2020-05-28 18:15:23 +08:00
parent a94f32f140
commit cd229a2fb4
1 changed files with 49 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -41,6 +41,9 @@
<arg><option>--body</option></arg>
<arg><option>--interface-info-header</option></arg>
<arg><option>--interface-info-body</option></arg>
<arg><option>--symbol-decorator</option> <replaceable>DECORATOR</replaceable></arg>
<arg><option>--symbol-decorator-header</option> <replaceable>HEADER</replaceable></arg>
<arg><option>--symbol-decorator-define</option> <replaceable>DEFINE</replaceable></arg>
<arg><option>--output</option> <replaceable>OUTFILE</replaceable></arg>
<group choice="plain" rep="repeat">
<arg>
@ -372,6 +375,52 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--symbol-decorator</option> <replaceable>DECORATOR</replaceable></term>
<listitem>
<para>
If a <literal>DECORATOR</literal> is passed in with this option, all the
generated function prototypes in the generated header will be marked with
<literal>DECORATOR</literal>. This can be used, for instance, to export
symbols from code generated with <command>gdbus-codegen</command>.
This option is added in GLib-2.66
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--symbol-decorator-header</option> <replaceable>HEADER</replaceable></term>
<listitem>
<para>
If a <literal>HEADER</literal> is passed in with this option, the
generated header will put a <literal>#include HEADER</literal> before the rest of the
items, except for the inclusion guards or <literal>#pragma once</literal>
(if <option>--pragma-once</option> is used). This is used if using another header file is
needed for the decorator passed in via <option>--symbol-decorator</option> to be defined.
This option is added in GLib-2.66.
</para>
<para>
This option can only be used if <option>--symbol-decorator</option> is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--symbol-decorator-define</option> <replaceable>DEFINE</replaceable></term>
<listitem>
<para>
If a <literal>DEFINE</literal> is passed in with this option, the
generated source will add a <literal>#define DEFINE</literal> before the rest of the
items. This is used if a particular macro is needed to ensure the decorator
passed in via <option>--symbol-decorator</option> uses the correct definition when the
generated source is being compiled. This option is added in GLib-2.66.
</para>
<para>
This option can only be used if <option>--symbol-decorator</option> is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--output</option> <replaceable>OUTFILE</replaceable></term>
<listitem>