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

docs: Mention Meson's gnome.mkenums_simple()

Browse Source 
The mkenums_simple() function generates idiomatic GObject code, and
avoids templates and custom command line arguments.
This commit is contained in:
Emmanuele Bassi 2019-05-21 18:25:34 +01:00
parent 79cdd531d0
commit 83c13e52d5
1 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/reference/gobject/glib-mkenums.xml
View File

@ -484,8 +484,8 @@ out of the box in its "gnome" module.
<para> <para>
In your <filename>meson.build</filename> file you will typically call the In your <filename>meson.build</filename> file you will typically call the
<literal>gnome.mkenums()</literal> method with a list of headers to inspect <literal>gnome.mkenums_simple()</literal> method to generate idiomatic enumeration
and the template files to use: types from a list of headers to inspect:
</para> </para>
<informalexample><programlisting> <informalexample><programlisting>
project_headers = [ project_headers = [
@ -495,10 +495,8 @@ project_headers = [
] ]
gnome = import('gnome') gnome = import('gnome')
enum_files = gnome.mkenums('enum-types', enum_files = gnome.mkenums_simple('enum-types',
sources: project_headers, sources: project_headers,
c_template: 'enum-types.c.in',
h_template: 'enum-types.h.in',
) )
</programlisting></informalexample> </programlisting></informalexample>
@ -530,9 +528,24 @@ internal dependency includes the generated header as a required source file:
mainlib_dep = declare_dependency(sources: enum_files[1], link_with: mainlib) mainlib_dep = declare_dependency(sources: enum_files[1], link_with: mainlib)
</programlisting></informalexample> </programlisting></informalexample>
<para> <para>
You should not include the generates source file, otherwise it will be built You should not include the generated source file as well, otherwise it will
twice. be built separately for every target that depends on it, causing build
failures.
</para> </para>
<para>
If you are generating C header and source files that require special
templates, you can use <literal>gnome.mkenums()</literal> to provide those
headers, for instance:
</para>
<informalexample><programlisting>
enum_files = gnome.mkenums('enum-types',
sources: project_headers,
h_template: 'enum-types.h.in',
c_template: 'enum-types.c.in',
install_header: true,
)
</programlisting></informalexample>
</refsect1> </refsect1>
<refsect1><title>Using glib-mkenums with Autotools</title> <refsect1><title>Using glib-mkenums with Autotools</title>