]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
seq: doc: generate documentation for alsaseq library
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Wed, 1 Apr 2020 09:13:28 +0000 (18:13 +0900)
committer坂本 貴史 <o-takashi@sakamocchi.jp>
Fri, 3 Apr 2020 13:06:25 +0000 (22:06 +0900)
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
doc/reference/meson.build
doc/reference/seq/alsaseq-docs.xml [new file with mode: 0644]
doc/reference/seq/alsaseq.types [new file with mode: 0644]
doc/reference/seq/meson.build [new file with mode: 0644]

index 70cb024ae63002c799bf40fb23a79db6c3d5c28a..3f746473d2c9f78de666cc6af9c5c2762bec1465 100644 (file)
@@ -9,3 +9,4 @@ configure_file(
 
 subdir('ctl')
 subdir('timer')
+subdir('seq')
diff --git a/doc/reference/seq/alsaseq-docs.xml b/doc/reference/seq/alsaseq-docs.xml
new file mode 100644 (file)
index 0000000..5835ebe
--- /dev/null
@@ -0,0 +1,52 @@
+<?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>ALSASeq Reference Manual</title>
+    <releaseinfo>This document is for the ALSASeq library, version &version;.
+    </releaseinfo>
+    </bookinfo>
+
+    <chapter id="alsaseq-enumerations">
+        <title>ALSASeq enumerations</title>
+        <xi:include href="xml/alsaseq-enum-types.xml"/>
+    </chapter>
+
+    <chapter id="alsaseq-global-methods">
+        <title>ALSASeq global methods</title>
+        <xi:include href="xml/query.xml"/>
+    </chapter>
+
+    <chapter id="alsaseq-objects">
+        <title>ALSASeq objects</title>
+        <xi:include href="xml/system-info.xml"/>
+        <xi:include href="xml/client-info.xml"/>
+        <xi:include href="xml/user-client.xml"/>
+        <xi:include href="xml/client-pool.xml"/>
+        <xi:include href="xml/addr.xml"/>
+        <xi:include href="xml/port-info.xml"/>
+        <xi:include href="xml/subscribe-data.xml"/>
+        <xi:include href="xml/event.xml"/>
+        <xi:include href="xml/event-fixed.xml"/>
+        <xi:include href="xml/event-variable.xml"/>
+        <xi:include href="xml/tstamp.xml"/>
+        <xi:include href="xml/event-data-result.xml"/>
+        <xi:include href="xml/event-data-note.xml"/>
+        <xi:include href="xml/event-data-ctl.xml"/>
+        <xi:include href="xml/event-data-queue.xml"/>
+        <xi:include href="xml/event-data-connect.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/seq/alsaseq.types b/doc/reference/seq/alsaseq.types
new file mode 100644 (file)
index 0000000..601a5bc
--- /dev/null
@@ -0,0 +1,32 @@
+alsaseq_addr_get_type
+alsaseq_client_info_get_type
+alsaseq_client_pool_get_type
+alsaseq_client_type_get_type
+alsaseq_event_data_connect_get_type
+alsaseq_event_data_ctl_get_type
+alsaseq_event_data_note_get_type
+alsaseq_event_data_queue_get_type
+alsaseq_event_data_result_get_type
+alsaseq_event_fixed_get_type
+alsaseq_event_get_type
+alsaseq_event_length_mode_get_type
+alsaseq_event_priority_mode_get_type
+alsaseq_event_time_mode_get_type
+alsaseq_event_timestamp_mode_get_type
+alsaseq_event_type_get_type
+alsaseq_event_variable_get_type
+alsaseq_filter_attr_flag_get_type
+alsaseq_port_attr_flag_get_type
+alsaseq_port_cap_flag_get_type
+alsaseq_port_subscribe_flag_get_type
+alsaseq_port_info_get_type
+alsaseq_port_subscribe_flag_get_type
+alsaseq_query_subscribe_type_get_type
+alsaseq_specific_address_get_type
+alsaseq_specific_client_id_get_type
+alsaseq_specific_port_id_get_type
+alsaseq_specific_queue_id_get_type
+alsaseq_subscribe_data_get_type
+alsaseq_system_info_get_type
+alsaseq_tstamp_get_type
+alsaseq_user_client_get_type
diff --git a/doc/reference/seq/meson.build b/doc/reference/seq/meson.build
new file mode 100644 (file)
index 0000000..c34d107
--- /dev/null
@@ -0,0 +1,10 @@
+gnome.gtkdoc('alsaseq',
+  src_dir : alsaseq_dir,
+  main_xml : 'alsaseq-docs.xml',
+  scan_args: [
+    '--ignore-headers=privates.h',
+  ],
+  gobject_typesfile: 'alsaseq.types',
+  dependencies: alsaseq_dependency,
+  install : true,
+)