timer: doc: generate documentation

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

diff --git a/doc/reference/meson.build b/doc/reference/meson.build
index 6ee74d836e40d53618cc62e443dddefd24e5cb98..70cb024ae63002c799bf40fb23a79db6c3d5c28a 100644 (file)
--- a/doc/reference/meson.build
+++ b/doc/reference/meson.build
@@ -8,3 +8,4 @@ configure_file(
 )
 
 subdir('ctl')
+subdir('timer')

diff --git a/doc/reference/timer/alsatimer-docs.xml b/doc/reference/timer/alsatimer-docs.xml
new file mode 100644 (file)
index 0000000..4bb3981
--- /dev/null
+++ b/doc/reference/timer/alsatimer-docs.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+                      "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+<!ENTITY version SYSTEM "../version.xml">
+]>
+
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+    <bookinfo>
+        <title>ALSATimer Reference Manual</title>
+    <releaseinfo>This document is for the ALSATimer library, version &version;.
+    </releaseinfo>
+    </bookinfo>
+
+    <chapter id="alsatimer-enumerations">
+        <title>ALSATimer enumerations</title>
+        <xi:include href="xml/alsatimer-enum-types.xml"/>
+    </chapter>
+
+    <chapter id="alsatimer-global-methods">
+        <title>ALSATimer global methods</title>
+        <xi:include href="xml/query.xml"/>
+    </chapter>
+
+    <chapter id="alsatimer-objects">
+        <title>ALSATimer objects</title>
+        <xi:include href="xml/device-id.xml"/>
+        <xi:include href="xml/device-info.xml"/>
+        <xi:include href="xml/device-status.xml"/>
+        <xi:include href="xml/device-params.xml"/>
+        <xi:include href="xml/user-instance.xml"/>
+        <xi:include href="xml/instance-info.xml"/>
+        <xi:include href="xml/instance-status.xml"/>
+        <xi:include href="xml/instance-params.xml"/>
+        <xi:include href="xml/event-data.xml"/>
+        <xi:include href="xml/event-data-tick.xml"/>
+        <xi:include href="xml/event-data-timestamp.xml"/>
+    </chapter>
+
+    <index id="index-all">
+        <title>Index of all symbols</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>

diff --git a/doc/reference/timer/alsatimer.types b/doc/reference/timer/alsatimer.types
new file mode 100644 (file)
index 0000000..867014b
--- /dev/null
+++ b/doc/reference/timer/alsatimer.types
@@ -0,0 +1,18 @@
+alsatimer_class_get_type
+alsatimer_slave_class_get_type
+alsatimer_specific_global_device_get_type
+alsatimer_device_info_flag_get_type
+alsatimer_instance_param_flag_get_type
+alsatimer_event_type_get_type
+alsatimer_event_data_type_get_type
+alsatimer_device_id_get_type
+alsatimer_device_info_get_type
+alsatimer_device_status_get_type
+alsatimer_device_params_get_type
+alsatimer_user_instance_get_type
+alsatimer_instance_info_get_type
+alsatimer_instance_params_get_type
+alsatimer_instance_status_get_type
+alsatimer_event_data_get_type
+alsatimer_event_data_tick_get_type
+alsatimer_event_data_timestamp_get_type

diff --git a/doc/reference/timer/meson.build b/doc/reference/timer/meson.build
new file mode 100644 (file)
index 0000000..37df220
--- /dev/null
+++ b/doc/reference/timer/meson.build
@@ -0,0 +1,10 @@
+gnome.gtkdoc('alsatimer',
+  src_dir : alsatimer_dir,
+  main_xml : 'alsatimer-docs.xml',
+  scan_args: [
+    '--ignore-headers=privates.h',
+  ],
+  gobject_typesfile: 'alsatimer.types',
+  dependencies: alsatimer_dependency,
+  install : true,
+)