From: Takashi Sakamoto Date: Wed, 16 Mar 2022 00:03:48 +0000 (+0900) Subject: rawmidi: migrate to gi-docgen from gtk-doc X-Git-Tag: v0.3.0~245 X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=4dfdcc675a2ab1b9cd3a23efb6b596d5ca06df98;p=alsa-gobject.git rawmidi: migrate to gi-docgen from gtk-doc This commit uses gi-docgen and obsolete gtk-doc. Signed-off-by: Takashi Sakamoto --- diff --git a/doc/meson.build b/doc/meson.build index 8575a66..2bdc78a 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -11,4 +11,5 @@ gidocgen = find_program('gi-docgen') subdir('ctl') subdir('hwdep') +subdir('rawmidi') subdir('reference') diff --git a/doc/rawmidi/alsarawmidi.toml.in b/doc/rawmidi/alsarawmidi.toml.in new file mode 100644 index 0000000..7ca263c --- /dev/null +++ b/doc/rawmidi/alsarawmidi.toml.in @@ -0,0 +1,34 @@ +[library] +version = "@VERSION@" +description = "alsarawmidi" +authors = "Takashi Sakamoto" +license = "LGPL-3.0-or-later" +website_url = "https://alsa-project.github.io/alsa-gobject-docs/alsarawmidi/" +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", +] + +[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/" + +[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/rawmidi/meson.build b/doc/rawmidi/meson.build new file mode 100644 index 0000000..4a547ce --- /dev/null +++ b/doc/rawmidi/meson.build @@ -0,0 +1,27 @@ +ext_contents = [ + 'overview.md', +] + +doc_toml = configure_file( + input: 'alsarawmidi.toml.in', + output: 'alsarawmidi.toml', + configuration: conf, +) + +custom_target('alsarawmidi-doc', + input: [ doc_toml, alsarawmidi_gir[0] ], + output: 'alsarawmidi', + command: [ + gidocgen, + 'generate', + '--no-namespace-dir', + '--config=@INPUT0@', + '--output-dir=@OUTPUT@', + '--content-dir=@0@'.format(meson.current_source_dir()), + '@INPUT1@', + ], + depend_files: [ ext_contents ], + build_by_default: true, + install: true, + install_dir: doc_dir, +) diff --git a/doc/rawmidi/overview.md b/doc/rawmidi/overview.md new file mode 100644 index 0000000..f2e2b2e --- /dev/null +++ b/doc/rawmidi/overview.md @@ -0,0 +1,6 @@ +Title: Overview + +This library is designed for applications to manipulate ALSA Rawmidi character device and operate +rawmidi functionality abstracted as a pair of streams and substream. ALSARawmidiStreamPair +represents the pair of streams. It holds file descriptor and creates GSource for event dispathing +by GLib's GMainContext/GMainLoop. diff --git a/doc/rawmidi/urlmap.js b/doc/rawmidi/urlmap.js new file mode 100644 index 0000000..915cb9d --- /dev/null +++ b/doc/rawmidi/urlmap.js @@ -0,0 +1,4 @@ +baseURLs = [ + [ 'GLib', 'https://docs.gtk.org/glib/' ], + [ 'GObject', 'https://docs.gtk.org/gobject/' ], +] diff --git a/doc/reference/meson.build b/doc/reference/meson.build index aad0fad..d1c4adc 100644 --- a/doc/reference/meson.build +++ b/doc/reference/meson.build @@ -6,4 +6,3 @@ configure_file( subdir('timer') subdir('seq') -subdir('rawmidi') diff --git a/doc/reference/rawmidi/alsarawmidi-docs.xml b/doc/reference/rawmidi/alsarawmidi-docs.xml deleted file mode 100644 index 392bbeb..0000000 --- a/doc/reference/rawmidi/alsarawmidi-docs.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - -]> - - - - ALSARawmidi Reference Manual - This document is for the ALSARawmidi library, version &version;. - - - - - Introduction - This library is designed for applications to manipulate ALSA - Rawmidi character device and operate rawmidi functionality abstracted - as a pair of streams and substream. ALSARawmidiStreamPair represents - the pair of streams. It holds file descriptor and creates GSource for - event dispathing by GLib's GMainContext/GMainLoop. - - - - ALSARawmidi enumerations - - - - - ALSARawmidi global methods - - - - - ALSARawmidi objects - - - - - - - - Index of all symbols - - - - - - diff --git a/doc/reference/rawmidi/alsarawmidi.types b/doc/reference/rawmidi/alsarawmidi.types deleted file mode 100644 index 21fe64f..0000000 --- a/doc/reference/rawmidi/alsarawmidi.types +++ /dev/null @@ -1,6 +0,0 @@ -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 deleted file mode 100644 index a0bbdb3..0000000 --- a/doc/reference/rawmidi/meson.build +++ /dev/null @@ -1,10 +0,0 @@ -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, -)