doc: Add documentation build

doc/libinputsynth-docs.xml

+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<book id="index">
+  <bookinfo>
+    <title>Libinputsynth Reference Manual</title>
+    <releaseinfo>
+      <para>This document is the API reference for the Libinputsynth library.</para>
+      <para>
+        The latest version of Libinputsynth, as well as the latest version of
+        this API reference, is <ulink role="online-location" url="https://gitlab.freedesktop.org/xrdesktop/libinputsynth">available online</ulink>.
+      </para>
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>libinputsynth</title>
+
+    <refsect2 id="overview">
+      <para>
+        libinputsynth is a library for synthesizing mouse and keyboard events
+        on X11 and wayland.
+      </para>
+    </refsect2>
+
+  <xi:include href="xml/inputsynth.xml"/>
+
+  </chapter>
+  <index id="api-index">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <!--
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+  -->
+</book>

doc/libinputsynth-sections.txt

+<SECTION>
+<FILE>inputsynth</FILE>
+<TITLE>InputSynth</TITLE>
+INPUT_TYPE_SYNTH
+InputSynthClass
+InputsynthBackend
+input_synth_new
+input_synth_move_cursor
+input_synth_click
+input_synth_character
+input_synth_get_backend_name
+InputSynth
+</SECTION>
+
+<SECTION>
+<FILE>inputsynth-version</FILE>
+DESKTOP_INPUT_SYNTHESIZER_MAJOR_VERSION
+DESKTOP_INPUT_SYNTHESIZER_MINOR_VERSION
+DESKTOP_INPUT_SYNTHESIZER_MICRO_VERSION
+DESKTOP_INPUT_SYNTHESIZER_VERSION
+DESKTOP_INPUT_SYNTHESIZER_VERSION_S
+DESKTOP_INPUT_SYNTHESIZER_ENCODE_VERSION
+DESKTOP_INPUT_SYNTHESIZER_VERSION_HEX
+DESKTOP_INPUT_SYNTHESIZER_CHECK_VERSION
+</SECTION>
+
+<SECTION>
+<FILE>inputsynth-wayland-clutter</FILE>
+<TITLE>InputSynthWaylandClutter</TITLE>
+INPUT_TYPE_SYNTH_WAYLAND_CLUTTER
+InputSynthWaylandClutterClass
+input_synth_wayland_clutter_new
+InputSynthWaylandClutter
+</SECTION>
+
+<SECTION>
+<FILE>inputsynth-x11-helper</FILE>
+init_helper_x11
+</SECTION>
+
+<SECTION>
+<FILE>inputsynth-xdo</FILE>
+<TITLE>InputSynthXdo</TITLE>
+INPUT_TYPE_SYNTH_XDO
+InputSynthXdoClass
+InputSynthXdo
+</SECTION>
+
+<SECTION>
+<FILE>inputsynth-xi2</FILE>
+<TITLE>InputSynthXi2</TITLE>
+INPUT_SYNTH_MASTER_CREATE_NAME
+INPUT_SYNTH_MASTER_NAME
+INPUT_SYNTH_SLAVE_NAME
+INPUT_SYNTH_KEYBOARD_SLAVE_NAME
+INPUT_TYPE_SYNTH_XI2
+InputSynthXi2Class
+InputSynthXi2
+</SECTION>
+

doc/meson.build

+subdir('xml')
+
+private_headers = [
+  'config.h',
+  'inputsynth-version.h',
+  'inputsynth-wayland-clutter.h',
+  'inputsynth-xdo.h',
+  'inputsynth-xi2.h'
+]
+
+modules = [
+  'inputsynth-wayland-clutter.c',
+  'inputsynth-xdo.c',
+  'inputsynth-xi2.c'
+]
+
+glib_prefix = dependency('glib-2.0').get_pkgconfig_variable('prefix')
+glib_docpath = join_paths(glib_prefix, 'share', 'gtk-doc', 'html')
+docpath = join_paths(inputsynth_datadir, 'gtk-doc', 'html')
+
+gnome.gtkdoc('libinputsynth',
+  main_xml: 'libinputsynth-docs.xml',
+  src_dir: [
+    src_inc,
+  ],
+  dependencies: inputsynth_dep,
+
+  scan_args: [
+    '--rebuild-types',
+    '--ignore-headers=' + ' '.join(private_headers)
+  ],
+  mkdb_args: [
+    '--default-include=inputsynth.h',
+  ],
+  fixxref_args: [
+    '--html-dir=@0@'.format(docpath),
+    '--extra-dir=@0@'.format(join_paths(glib_docpath, 'glib')),
+    '--extra-dir=@0@'.format(join_paths(glib_docpath, 'gobject')),
+    '--extra-dir=@0@'.format(join_paths(glib_docpath, 'graphene')),
+  ],
+  # html_assets: html_images,
+  install: true,
+)

doc/xml/gtkdocentities.ent.in

+<!ENTITY package "@PACKAGE@">
+<!ENTITY package_bugreport "@PACKAGE_BUGREPORT@">
+<!ENTITY package_name "@PACKAGE_NAME@">
+<!ENTITY package_string "@PACKAGE_STRING@">
+<!ENTITY package_tarname "@PACKAGE_TARNAME@">
+<!ENTITY package_url "@PACKAGE_URL@">
+<!ENTITY package_version "@PACKAGE_VERSION@">
+<!ENTITY package_api_version "@PACKAGE_API_VERSION@">

doc/xml/meson.build

+ent_conf = configuration_data()
+ent_conf.set('PACKAGE', 'libinputsynth')
+ent_conf.set('PACKAGE_BUGREPORT', 'https://gitlab.freedesktop.org/xrdesktop/libinputsynth')
+ent_conf.set('PACKAGE_NAME', 'libinputsynth')
+ent_conf.set('PACKAGE_STRING', 'libinputsynth')
+ent_conf.set('PACKAGE_TARNAME', 'libinputsynth-' + meson.project_version())
+ent_conf.set('PACKAGE_URL', 'https://gitlab.freedesktop.org/xrdesktop/libinputsynth')
+ent_conf.set('PACKAGE_VERSION', meson.project_version())
+ent_conf.set('PACKAGE_API_VERSION', api_version)
+configure_file(input: 'gtkdocentities.ent.in', output: 'gtkdocentities.ent', configuration: ent_conf)

meson.build

@@ -2,6 +2,7 @@ project('libinputsynth', 'c', version: '0.12.1',
   meson_version: '>= 0.45.1',
 )
 
+gnome = import('gnome')
 
 config_h = configuration_data()
 config_h.set_quoted('PACKAGE_VERSION', meson.project_version())
@@ -38,6 +39,13 @@ endif
 
 add_project_arguments([project_args], language: ['c'])
 
+# Paths
+inputsynth_prefix = get_option('prefix')
+inputsynth_libdir = join_paths(inputsynth_prefix, get_option('libdir'))
+inputsynth_includedir = join_paths(inputsynth_prefix, get_option('includedir'))
+inputsynth_datadir = join_paths(inputsynth_prefix, get_option('datadir'))
+src_inc = include_directories('src')
+
 gio_dep = dependency('gio-2.0', version: '>= 2.50')
 glib_dep = dependency('glib-2.0')
 gmodule_dep = dependency('gmodule-2.0')
@@ -58,3 +66,7 @@ endif
 subdir('src')
 subdir('examples')
 subdir('tests')
+
+if get_option('api_doc')
+    subdir('doc')
+endif

meson_options.txt

+option('api_doc',
+  type: 'boolean',
+  value: false,
+  description: 'Build API documentation using GTK-Doc'
+)
+
+option('introspection', type : 'boolean', value : false)

src/inputsynth.c

@@ -143,7 +143,7 @@ input_synth_move_cursor (InputSynth *self, int x, int y)
  * @x: The x coordinate to click at (may have no effect depending on backend)
  * @y: The y coordinate to click at (may have no effect depending on backend)
  * @button: The button to click.
- * Usual Bindings:
+ * The usual bindings are:
  *  * Button 1: Left Click
  *  * Button 2: Right Click
  *  * Button 3: Middle (Mouse Wheel) Click
@@ -165,7 +165,7 @@ input_synth_click (InputSynth *self, int x, int y,
 /**
  * input_synth_character:
  * @self: The #InputSynth
- * @c: The ASCII character to input.
+ * @c: The ASCII character to synthesize.
  */
 void
 input_synth_character (InputSynth *self, char c)
@@ -179,7 +179,7 @@ input_synth_character (InputSynth *self, char c)
  * input_synth_get_backend_name:
  * @self: The #InputSynth
  * Returns: A purely informational descriptive name for the backend
- * currently in use. Can be used to test if loading of backend succeeds.
+ * currently in use. Useful when testing backend loading.
  */
 GString *
 input_synth_get_backend_name (InputSynth *self)

src/inputsynth.h

@@ -20,11 +20,8 @@ struct _InputSynthClass
 {
   GObjectClass parent_class;
   void (*move_cursor) (InputSynth *self, int x, int y);
-
   void (*click) (InputSynth *self, int x, int y, int button, gboolean press);
-
   void (*character) (InputSynth *self, char c);
-
   GString * (*get_backend_name) (InputSynth *self);
 };
 

src/meson.build

@@ -135,3 +135,25 @@ if mutter_clutter_dep.found()
   )
 endif
 
+inputsynth_dep = declare_dependency(
+  sources: [],
+  link_with: inputsynth_lib,
+  include_directories: [ inputsynth_inc ],
+  dependencies: inputsynth_deps,
+)
+
+if get_option('introspection')
+  inputsynth_gir = gnome.generate_gir(
+    inputsynth_lib,
+    sources: inputsynth_sources + inputsynth_headers,
+    namespace: 'libinputsynth',
+    nsversion: api_version,
+    identifier_prefix: 'libinputsynth',
+    symbol_prefix: 'libinputsynth',
+    export_packages: api_path,
+    includes: [ ],
+    header: 'libinputsynth/inputsynth.h',
+    install: true,
+  )
+endif
+