From: Takashi Sakamoto Date: Thu, 21 Nov 2019 04:13:58 +0000 (+0900) Subject: ctl: generate documentation X-Git-Tag: v0.1.0~379 X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=a9defdbfa0ad7e2a771541934673082992cecb43;p=alsa-gobject.git ctl: generate documentation --- diff --git a/doc/meson.build b/doc/meson.build new file mode 100644 index 0000000..2e2fe14 --- /dev/null +++ b/doc/meson.build @@ -0,0 +1,3 @@ +if get_option('gtk_doc') + subdir('reference') +endif diff --git a/doc/reference/ctl/alsactl-docs.xml b/doc/reference/ctl/alsactl-docs.xml new file mode 100644 index 0000000..16d0e67 --- /dev/null +++ b/doc/reference/ctl/alsactl-docs.xml @@ -0,0 +1,48 @@ + + + +]> + + + + ALSACtl Reference Manual + This document is for the ALSACtl library, version &version;. + + + + + ALSACtl enumerations + + + + + ALSACtl global methods + + + + + ALSACtl objects + + + + + + + + + + + + + + + + Index of all symbols + + + + + + diff --git a/doc/reference/ctl/alsactl.types b/doc/reference/ctl/alsactl.types new file mode 100644 index 0000000..64fb51f --- /dev/null +++ b/doc/reference/ctl/alsactl.types @@ -0,0 +1,16 @@ +alsactl_elem_type_get_type +alsactl_elem_iface_type_get_type +alsactl_elem_access_flag_get_type +alsactl_event_type_get_type +alsactl_event_mask_flag_get_type +alsactl_card_get_type +alsactl_card_info_get_type +alsactl_elem_id_get_type +alsactl_elem_info_get_type +alsactl_elem_info_bool_get_type +alsactl_elem_info_int_get_type +alsactl_elem_info_enum_get_type +alsactl_elem_info_bytes_get_type +alsactl_elem_info_iec60958_get_type +alsactl_elem_info_int64_get_type +alsactl_elem_value_get_type diff --git a/doc/reference/ctl/meson.build b/doc/reference/ctl/meson.build new file mode 100644 index 0000000..40bf47f --- /dev/null +++ b/doc/reference/ctl/meson.build @@ -0,0 +1,10 @@ +gnome.gtkdoc('alsactl', + src_dir : alsactl_dir, + main_xml : 'alsactl-docs.xml', + scan_args: [ + '--ignore-headers=privates.h', + ], + gobject_typesfile: 'alsactl.types', + dependencies: alsactl_dependency, + install : true, +) diff --git a/doc/reference/meson.build b/doc/reference/meson.build new file mode 100644 index 0000000..6ee74d8 --- /dev/null +++ b/doc/reference/meson.build @@ -0,0 +1,10 @@ +conf = configuration_data() +conf.set('VERSION', meson.project_version()) + +configure_file( + input : 'version.xml.in', + output : 'version.xml', + configuration : conf, +) + +subdir('ctl') diff --git a/doc/reference/version.xml.in b/doc/reference/version.xml.in new file mode 100644 index 0000000..d78bda9 --- /dev/null +++ b/doc/reference/version.xml.in @@ -0,0 +1 @@ +@VERSION@ diff --git a/meson.build b/meson.build index 9f9ff0b..2a7b10e 100644 --- a/meson.build +++ b/meson.build @@ -7,3 +7,4 @@ gnome = import('gnome') subdir('src') subdir('tests') +subdir('doc') diff --git a/meson_options.txt b/meson_options.txt new file mode 100644 index 0000000..9cbd3c2 --- /dev/null +++ b/meson_options.txt @@ -0,0 +1,5 @@ +option('gtk_doc', + type: 'boolean', + value: false, + description: 'generate API reference', +)