doc/reference/libpurple/meson.build

Tue, 06 Nov 2018 16:21:25 -0600

author
Mike Ruprecht <cmaiku@gmail.com>
date
Tue, 06 Nov 2018 16:21:25 -0600
changeset 39283
64bf48e23160
parent 39232
ec0083623643
child 39299
0788d086b7c1
permissions
-rw-r--r--

Fix Facebook documentation pointing to a missing version.xml file

The Facebook protocol plugin documentation was attempting to point to
a version.xml file in doc/reference/protocols/ which wasn't being
generated. This caused its documentation to fail to build. This patch
removes the remnants of that and has it point to the libpurple
version.xml as it doesn't make sense to have a separate protocol
version to me as is.

38515
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
1 DOC_MODULE = 'libpurple'
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
2
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
3 # Header files or dirs to ignore when scanning. Use base file/dir names
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
4 ignore_hfiles = [
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
5 'example',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
6 'plugins',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
7 'protocols',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
8 'tests',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
9 'win32',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
10 'backend-fs2.h',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
11 'dbus-define-api.h',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
12 'dbus-types.h',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
13 'glibcompat.h',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
14 'internal.h',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
15 'purple-client.h',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
16 'purple-client-bindings.h',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
17 ]
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
18
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
19 # Extra options to supply to gtkdoc-scan.
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
20 scan_args = [
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
21 '--deprecated-guards=PURPLE_DISABLE_DEPRECATED',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
22 '--rebuild-types',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
23 '--rebuild-sections',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
24 '--ignore-headers=' + ' '.join(ignore_hfiles),
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
25 ]
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
26
38551
0090f66eafdc doc: Add IGNORE_HFILES to MKDB_OPTIONS
Mike Ruprecht <cmaiku@gmail.com>
parents: 38515
diff changeset
27 # Extra options to supply to gtkdoc-mkdb.
0090f66eafdc doc: Add IGNORE_HFILES to MKDB_OPTIONS
Mike Ruprecht <cmaiku@gmail.com>
parents: 38515
diff changeset
28 mkdb_args = [
0090f66eafdc doc: Add IGNORE_HFILES to MKDB_OPTIONS
Mike Ruprecht <cmaiku@gmail.com>
parents: 38515
diff changeset
29 '--ignore-files=' + ' '.join(ignore_hfiles),
0090f66eafdc doc: Add IGNORE_HFILES to MKDB_OPTIONS
Mike Ruprecht <cmaiku@gmail.com>
parents: 38515
diff changeset
30 ]
0090f66eafdc doc: Add IGNORE_HFILES to MKDB_OPTIONS
Mike Ruprecht <cmaiku@gmail.com>
parents: 38515
diff changeset
31
38515
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
32 libpurple_version_xml = configure_file(
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
33 input : 'version.xml.in',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
34 output : 'version.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
35 configuration : version_conf)
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
36
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
37 content_files = [
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
38 'plugin_i18n.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
39 'plugin_ids.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
40 'signals_account.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
41 'signals_blist.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
42 'signals_certificate.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
43 'signals_cmd.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
44 'signals_connection.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
45 'signals_conversation.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
46 'signals_core.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
47 'signals_dbus_server.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
48 'signals_jabber.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
49 'signals_log.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
50 'signals_notify.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
51 'signals_plugin.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
52 'signals_protocol.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
53 'signals_savedstatus.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
54 'signals_sound.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
55 'signals_xfer.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
56 'tut_c_plugins.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
57 'tut_signals.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
58 'ui_ops.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
59 ]
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
60
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
61 gnome.gtkdoc(DOC_MODULE,
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
62 main_xml : DOC_MODULE + '-docs.xml',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
63 src_dir : libpurple_inc,
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
64 dependencies : libpurple_dep,
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
65 install : true,
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
66 scan_args : scan_args,
38551
0090f66eafdc doc: Add IGNORE_HFILES to MKDB_OPTIONS
Mike Ruprecht <cmaiku@gmail.com>
parents: 38515
diff changeset
67 mkdb_args : mkdb_args,
38515
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
68 gobject_typesfile : DOC_MODULE + '.types',
2d4d3a8fd23c Add documentation to Meson build.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
diff changeset
69 content_files : content_files)

mercurial