]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
rawmidi: doc: generate documentation of ALSARawmidi library
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Thu, 21 Nov 2019 05:06:34 +0000 (14:06 +0900)
committer坂本 貴史 <o-takashi@sakamocchi.jp>
Sun, 12 Apr 2020 05:30:33 +0000 (14:30 +0900)
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
doc/reference/meson.build
doc/reference/rawmidi/alsarawmidi-docs.xml [new file with mode: 0644]
doc/reference/rawmidi/alsarawmidi.types [new file with mode: 0644]
doc/reference/rawmidi/meson.build [new file with mode: 0644]

index a03ee90c47d760204602d7db660cf6e79714f65a..c06839628a1dbb124b070b5c7b1fdf273b769354 100644 (file)
@@ -11,3 +11,4 @@ subdir('ctl')
 subdir('timer')
 subdir('seq')
 subdir('hwdep')
+subdir('rawmidi')
diff --git a/doc/reference/rawmidi/alsarawmidi-docs.xml b/doc/reference/rawmidi/alsarawmidi-docs.xml
new file mode 100644 (file)
index 0000000..284556c
--- /dev/null
@@ -0,0 +1,40 @@
+<?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>ALSARawmidi Reference Manual</title>
+    <releaseinfo>This document is for the ALSARawmidi library, version &version;.
+    </releaseinfo>
+    </bookinfo>
+
+    <chapter id="alsarawmidi-enumerations">
+        <title>ALSARawmidi enumerations</title>
+        <xi:include href="xml/alsarawmidi-enum-types.xml"/>
+    </chapter>
+
+    <chapter id="alsarawmidi-global-methods">
+        <title>ALSARawmidi global methods</title>
+        <xi:include href="xml/query.xml"/>
+    </chapter>
+
+    <chapter id="alsarawmidi-objects">
+        <title>ALSARawmidi objects</title>
+        <xi:include href="xml/stream-pair.xml"/>
+        <xi:include href="xml/substream-info.xml"/>
+        <xi:include href="xml/substream-params.xml"/>
+        <xi:include href="xml/substream-status.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/rawmidi/alsarawmidi.types b/doc/reference/rawmidi/alsarawmidi.types
new file mode 100644 (file)
index 0000000..21fe64f
--- /dev/null
@@ -0,0 +1,6 @@
+alsarawmidi_stream_direction_get_type
+alsarawmidi_stream_pair_info_flag_get_type
+alsarawmidi_substream_info_get_type
+alsarawmidi_stream_pair_get_type
+alsarawmidi_substream_params_get_type
+alsarawmidi_substream_status_get_type
diff --git a/doc/reference/rawmidi/meson.build b/doc/reference/rawmidi/meson.build
new file mode 100644 (file)
index 0000000..a0bbdb3
--- /dev/null
@@ -0,0 +1,10 @@
+gnome.gtkdoc('alsarawmidi',
+  src_dir : alsarawmidi_dir,
+  main_xml : 'alsarawmidi-docs.xml',
+  scan_args: [
+    '--ignore-headers=privates.h',
+  ],
+  gobject_typesfile: 'alsarawmidi.types',
+  dependencies: alsarawmidi_dependency,
+  install : true,
+)