seq: migrate to gi-docgen from gtk-doc

This commit uses gi-docgen and obsolete gtk-doc.

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

diff --git a/doc/meson.build b/doc/meson.build
index 177b259a5a55a63e45f755d0519e3a913f4946c7..f1f6c4ef42d0e7e473352d317a2d231b5fdda0d8 100644 (file)
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -13,4 +13,4 @@ subdir('ctl')
 subdir('hwdep')
 subdir('rawmidi')
 subdir('timer')
-subdir('reference')
+subdir('seq')

diff --git a/doc/reference/meson.build b/doc/reference/meson.build
deleted file mode 100644 (file)
index cdfb568..0000000
--- a/doc/reference/meson.build
+++ /dev/null
@@ -1,7 +0,0 @@
-configure_file(
-  input : 'version.xml.in',
-  output : 'version.xml',
-  configuration : conf,
-)
-
-subdir('seq')

diff --git a/doc/reference/seq/alsaseq-docs.xml b/doc/reference/seq/alsaseq-docs.xml
deleted file mode 100644 (file)
index 23658be..0000000
--- a/doc/reference/seq/alsaseq-docs.xml
+++ /dev/null
@@ -1,65 +0,0 @@
-<?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="introduction">
-        <title>Introduction</title>
-        <para>This library is designed for applications to manipulate ALSA
-        sequencer character device and operate its functionality abstracted.
-        as user client, port, and event. ALSASeqUserClient represent the user
-        client. It holds file descriptor and creates GSource for event
-        dispatching by GLib's GMainContext/GMainLoop.</para>
-    </chapter>
-
-    <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/user-client.xml"/>
-        <xi:include href="xml/system-info.xml"/>
-        <xi:include href="xml/client-info.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-cntr.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"/>
-        <xi:include href="xml/queue-info.xml"/>
-        <xi:include href="xml/queue-status.xml"/>
-        <xi:include href="xml/queue-tempo.xml"/>
-        <xi:include href="xml/queue-timer.xml"/>
-        <xi:include href="xml/queue-timer-data-alsa.xml"/>
-        <xi:include href="xml/remove-filter.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
deleted file mode 100644 (file)
index bde0169..0000000
--- a/doc/reference/seq/alsaseq.types
+++ /dev/null
@@ -1,37 +0,0 @@
-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_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_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
-alsaseq_queue_timer_type_get_type
-alsaseq_remove_filter_flag_get_type
-alsaseq_queue_info_get_type
-alsaseq_queue_status_get_type
-alsaseq_queue_tempo_get_type
-alsaseq_queue_timer_get_type
-alsaseq_queue_timer_data_alsa_get_type
-alsaseq_event_cntr_get_type

diff --git a/doc/reference/seq/meson.build b/doc/reference/seq/meson.build
deleted file mode 100644 (file)
index c34d107..0000000
--- a/doc/reference/seq/meson.build
+++ /dev/null
@@ -1,10 +0,0 @@
-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,
-)

diff --git a/doc/reference/version.xml.in b/doc/reference/version.xml.in
deleted file mode 100644 (file)
index d78bda9..0000000
--- a/doc/reference/version.xml.in
+++ /dev/null
@@ -1 +0,0 @@
-@VERSION@

diff --git a/doc/seq/alsaseq.toml.in b/doc/seq/alsaseq.toml.in
new file mode 100644 (file)
index 0000000..26f5099
--- /dev/null
+++ b/doc/seq/alsaseq.toml.in
@@ -0,0 +1,40 @@
+[library]
+version = "@VERSION@"
+description = "alsaseq"
+authors = "Takashi Sakamoto"
+license = "LGPL-3.0-or-later"
+website_url = "https://alsa-project.github.io/alsa-gobject-docs/alsaseq/"
+browse_url = "https://github.com/alsa-project/alsa-gobject"
+repository_url = "https://github.com/alsa-project/alsa-gobject.git"
+
+dependencies = [
+  "GLib-2.0",
+  "GObject-2.0",
+  "ALSATimer-0.0",
+]
+
+[dependencies."GLib-2.0"]
+name = "GLib"
+description = "The base utility library"
+docs_url = "https://docs.gtk.org/glib/"
+
+[dependencies."GObject-2.0"]
+name = "GObject"
+description = "The base type system and object class"
+docs_url = "https://docs.gtk.org/gobject/"
+
+[dependencies."ALSATimer-0.0"]
+name = "ALSATimer"
+description = "GObject Introspection library with timer API in asound.h"
+docs_url = "https://alsa-project.github.io/alsa-gobject-docs/alsatimer/"
+
+[source-location]
+base_url = "https://github.com/alsa-project/alsa-gobject/blob/master/"
+file_format = "{filename}#L{line}"
+
+[extra]
+content_files = [
+  "overview.md",
+]
+
+urlmap_file = "urlmap.js"

diff --git a/doc/seq/meson.build b/doc/seq/meson.build
new file mode 100644 (file)
index 0000000..efe1e22
--- /dev/null
+++ b/doc/seq/meson.build
@@ -0,0 +1,28 @@
+ext_contents = [
+  'overview.md',
+]
+
+doc_toml = configure_file(
+  input: 'alsaseq.toml.in',
+  output: 'alsaseq.toml',
+  configuration: conf,
+)
+
+custom_target('alsaseq-doc',
+  input: [ doc_toml, alsaseq_gir[0] ],
+  output: 'alsaseq',
+  command: [
+    gidocgen,
+    'generate',
+    '--no-namespace-dir',
+    '--config=@INPUT0@',
+    '--output-dir=@OUTPUT@',
+    '--content-dir=@0@'.format(meson.current_source_dir()),
+    '--add-include-path=@0@'.format(build_dirs['alsatimer']),
+    '@INPUT1@',
+  ],
+  depend_files: [ ext_contents ],
+  build_by_default: true,
+  install: true,
+  install_dir: doc_dir,
+)

diff --git a/doc/seq/overview.md b/doc/seq/overview.md
new file mode 100644 (file)
index 0000000..7e7b7bb
--- /dev/null
+++ b/doc/seq/overview.md
@@ -0,0 +1,6 @@
+Title: Overview
+
+This library is designed for applications to manipulate ALSA sequencer character device and operate
+its functionality abstracted.  as user client, port, and event. ALSASeqUserClient represent the
+user client. It holds file descriptor and creates GSource for event dispatching by GLib's
+GMainContext/GMainLoop.

diff --git a/doc/seq/urlmap.js b/doc/seq/urlmap.js
new file mode 100644 (file)
index 0000000..ed56532
--- /dev/null
+++ b/doc/seq/urlmap.js
@@ -0,0 +1,5 @@
+baseURLs = [
+    [ 'GLib', 'https://docs.gtk.org/glib/' ],
+    [ 'GObject', 'https://docs.gtk.org/gobject/' ],
+    [ 'ALSATimer', 'https://alsa-project.github.io/alsa-gobject-docs/alsatimer/' ]
+]

diff --git a/src/seq/meson.build b/src/seq/meson.build
index 052f8ec2e9718f3c2800450c51a4dcd44131cfec..abdc9209fe41e2f58e3e52ae9c21903f57d68f42 100644 (file)
--- a/src/seq/meson.build
+++ b/src/seq/meson.build
@@ -141,7 +141,7 @@ pkg.generate(library,
 )
 
 # Generate metadata for gobject introspection.
-gnome.generate_gir(library,
+alsaseq_gir = gnome.generate_gir(library,
   sources: enums + headers + sources,
   nsversion: '0.0',
   namespace: namespace,
@@ -157,10 +157,3 @@ gnome.generate_gir(library,
   header: 'alsaseq.h',
   install: true,
 )
-
-# For documentation of gtk-doc.
-alsaseq_dir = include_directories('.')
-alsaseq_dependency = declare_dependency(
-  link_with: library,
-  dependencies: dependencies,
-)