From 757af51e610632bfbe507f3b644014467b417d61 Mon Sep 17 00:00:00 2001 From: Michal Ratajsky Date: Wed, 20 Aug 2014 22:49:43 +0200 Subject: Corrections to gtk-doc --- docs/reference/Makefile.am | 10 +- docs/reference/libmatemixer-docs.xml | 11 +- docs/reference/libmatemixer-sections.txt | 339 ++++++++++++++++++------------- 3 files changed, 208 insertions(+), 152 deletions(-) (limited to 'docs/reference') diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 9c58b70..4a6e205 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -53,12 +53,16 @@ EXTRA_HFILES= # Header files or dirs to ignore when scanning. Use base file/dir names # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code IGNORE_HFILES= \ + matemixer-app-info-private.h \ matemixer-backend.h \ matemixer-backend-module.h \ - matemixer-device-profile-private.h \ matemixer-enum-types.h \ - matemixer-port-private.h \ - matemixer-private.h + matemixer-stream-control-private.h \ + matemixer-stream-private.h \ + matemixer-switch-option-private.h \ + matemixer-switch-private.h \ + matemixer-private.h \ + matemixer-types.h # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png diff --git a/docs/reference/libmatemixer-docs.xml b/docs/reference/libmatemixer-docs.xml index 708ca6e..16c1a1f 100644 --- a/docs/reference/libmatemixer-docs.xml +++ b/docs/reference/libmatemixer-docs.xml @@ -16,12 +16,15 @@ API Reference - - + + - - + + + + + API Index diff --git a/docs/reference/libmatemixer-sections.txt b/docs/reference/libmatemixer-sections.txt index 5807f76..46e8a8d 100644 --- a/docs/reference/libmatemixer-sections.txt +++ b/docs/reference/libmatemixer-sections.txt @@ -1,191 +1,240 @@
matemixer +MateMixer mate_mixer_init -mate_mixer_deinit mate_mixer_is_initialized LIBMATEMIXER_CHECK_VERSION
-matemixer-client-stream -MateMixerClientStream -MateMixerClientStreamFlags -MateMixerClientStreamRole -MateMixerClientStream -MateMixerClientStreamInterface -mate_mixer_client_stream_get_flags -mate_mixer_client_stream_get_role -mate_mixer_client_stream_get_parent -mate_mixer_client_stream_set_parent -mate_mixer_client_stream_remove -mate_mixer_client_stream_get_app_name -mate_mixer_client_stream_get_app_id -mate_mixer_client_stream_get_app_version -mate_mixer_client_stream_get_app_icon +matemixer-app-info +MateMixerAppInfo +mate_mixer_app_info_get_name +mate_mixer_app_info_get_id +mate_mixer_app_info_get_version +mate_mixer_app_info_get_icon -MATE_MIXER_CLIENT_STREAM -MATE_MIXER_CLIENT_STREAM_GET_INTERFACE -MATE_MIXER_IS_CLIENT_STREAM -MATE_MIXER_TYPE_CLIENT_STREAM -mate_mixer_client_stream_get_type +MATE_MIXER_APP_INFO +MATE_MIXER_TYPE_APP_INFO +mate_mixer_app_info_get_type
-matemixer-control -MateMixerControl +matemixer-context +MateMixerContext MateMixerState MateMixerBackendType -MateMixerControl -mate_mixer_control_new -mate_mixer_control_set_backend_type -mate_mixer_control_set_app_name -mate_mixer_control_set_app_id -mate_mixer_control_set_app_version -mate_mixer_control_set_app_icon -mate_mixer_control_set_server_address -mate_mixer_control_open -mate_mixer_control_close -mate_mixer_control_get_state -mate_mixer_control_get_device -mate_mixer_control_get_stream -mate_mixer_control_get_cached_stream -mate_mixer_control_list_devices -mate_mixer_control_list_streams -mate_mixer_control_list_cached_streams -mate_mixer_control_get_default_input_stream -mate_mixer_control_set_default_input_stream -mate_mixer_control_get_default_output_stream -mate_mixer_control_set_default_output_stream -mate_mixer_control_get_backend_name -mate_mixer_control_get_backend_type +MateMixerBackendFlags +MateMixerContext +MateMixerContextClass +mate_mixer_context_new +mate_mixer_context_set_backend_type +mate_mixer_context_set_app_name +mate_mixer_context_set_app_id +mate_mixer_context_set_app_version +mate_mixer_context_set_app_icon +mate_mixer_context_set_server_address +mate_mixer_context_open +mate_mixer_context_close +mate_mixer_context_get_state +mate_mixer_context_get_device +mate_mixer_context_get_stream +mate_mixer_context_get_stored_control +mate_mixer_context_list_devices +mate_mixer_context_list_streams +mate_mixer_context_list_stored_controls +mate_mixer_context_get_default_input_stream +mate_mixer_context_set_default_input_stream +mate_mixer_context_get_default_output_stream +mate_mixer_context_set_default_output_stream +mate_mixer_context_get_backend_name +mate_mixer_context_get_backend_type +mate_mixer_context_get_backend_flags +MateMixerContextPrivate -MateMixerControlClass -MATE_MIXER_CONTROL -MATE_MIXER_CONTROL_CLASS -MATE_MIXER_CONTROL_GET_CLASS -MATE_MIXER_IS_CONTROL -MATE_MIXER_IS_CONTROL_CLASS -MATE_MIXER_TYPE_CONTROL -mate_mixer_control_get_type - -MateMixerControlPrivate +MATE_MIXER_CONTEXT +MATE_MIXER_CONTEXT_CLASS +MATE_MIXER_CONTEXT_GET_CLASS +MATE_MIXER_IS_CONTEXT +MATE_MIXER_IS_CONTEXT_CLASS +MATE_MIXER_TYPE_CONTEXT +mate_mixer_context_get_type
matemixer-device MateMixerDevice MateMixerDevice -MateMixerDeviceInterface +MateMixerDeviceClass mate_mixer_device_get_name -mate_mixer_device_get_description +mate_mixer_device_get_label mate_mixer_device_get_icon -mate_mixer_device_get_port -mate_mixer_device_get_profile -mate_mixer_device_list_ports -mate_mixer_device_list_profiles -mate_mixer_device_get_active_profile -mate_mixer_device_set_active_profile +mate_mixer_device_get_stream +mate_mixer_device_get_switch +mate_mixer_device_list_streams +mate_mixer_device_list_switches +MateMixerDevicePrivate MATE_MIXER_DEVICE -MATE_MIXER_DEVICE_GET_INTERFACE +MATE_MIXER_DEVICE_CLASS +MATE_MIXER_DEVICE_GET_CLASS MATE_MIXER_IS_DEVICE +MATE_MIXER_IS_DEVICE_CLASS MATE_MIXER_TYPE_DEVICE mate_mixer_device_get_type
-matemixer-device-profile -MateMixerDeviceProfile -MateMixerDeviceProfile -mate_mixer_device_profile_get_name -mate_mixer_device_profile_get_description -mate_mixer_device_profile_get_priority -mate_mixer_device_profile_get_num_input_streams -mate_mixer_device_profile_get_num_output_streams +matemixer-stored-control +MateMixerStoredControl +MateMixerStoredControlInterface +mate_mixer_stored_control_get_direction -MateMixerDeviceProfileClass -MATE_MIXER_IS_DEVICE_PROFILE -MATE_MIXER_IS_DEVICE_PROFILE_CLASS -MATE_MIXER_DEVICE_PROFILE -MATE_MIXER_DEVICE_PROFILE_CLASS -MATE_MIXER_DEVICE_PROFILE_GET_CLASS -MATE_MIXER_TYPE_DEVICE_PROFILE -mate_mixer_device_profile_get_type - -MateMixerDeviceProfilePrivate -
- -
-matemixer-port -MateMixerPort -MateMixerPortFlags -MateMixerPort -mate_mixer_port_get_name -mate_mixer_port_get_description -mate_mixer_port_get_icon -mate_mixer_port_get_priority -mate_mixer_port_get_flags - -MateMixerPortClass -MATE_MIXER_IS_PORT -MATE_MIXER_IS_PORT_CLASS -MATE_MIXER_PORT -MATE_MIXER_PORT_CLASS -MATE_MIXER_PORT_GET_CLASS -MATE_MIXER_TYPE_PORT -mate_mixer_port_get_type - -MateMixerPortPrivate +MATE_MIXER_IS_STORED_CONTROL +MATE_MIXER_STORED_CONTROL +MATE_MIXER_STORED_CONTROL_GET_INTERFACE +MATE_MIXER_TYPE_STORED_CONTROL +mate_mixer_stored_control_get_type
matemixer-stream MateMixerStream -MateMixerChannelPosition -MateMixerStreamFlags -MateMixerStreamState +MateMixerDirection MateMixerStream -MateMixerStreamInterface -MATE_MIXER_INFINITY +MateMixerStreamClass mate_mixer_stream_get_name -mate_mixer_stream_get_description +mate_mixer_stream_get_label +mate_mixer_stream_get_direction mate_mixer_stream_get_device -mate_mixer_stream_get_flags -mate_mixer_stream_get_state -mate_mixer_stream_get_mute -mate_mixer_stream_set_mute -mate_mixer_stream_get_num_channels -mate_mixer_stream_get_volume -mate_mixer_stream_set_volume -mate_mixer_stream_get_decibel -mate_mixer_stream_set_decibel -mate_mixer_stream_get_channel_position -mate_mixer_stream_get_channel_volume -mate_mixer_stream_set_channel_volume -mate_mixer_stream_get_channel_decibel -mate_mixer_stream_set_channel_decibel -mate_mixer_stream_has_channel_position -mate_mixer_stream_get_balance -mate_mixer_stream_set_balance -mate_mixer_stream_get_fade -mate_mixer_stream_set_fade -mate_mixer_stream_suspend -mate_mixer_stream_resume -mate_mixer_stream_monitor_start -mate_mixer_stream_monitor_stop -mate_mixer_stream_monitor_is_running -mate_mixer_stream_monitor_set_name -mate_mixer_stream_list_ports -mate_mixer_stream_get_active_port -mate_mixer_stream_set_active_port -mate_mixer_stream_get_min_volume -mate_mixer_stream_get_max_volume -mate_mixer_stream_get_normal_volume -mate_mixer_stream_get_base_volume +mate_mixer_stream_get_control +mate_mixer_stream_get_switch +mate_mixer_stream_get_default_control +mate_mixer_stream_list_controls +mate_mixer_stream_list_switches +MateMixerStreamPrivate MATE_MIXER_IS_STREAM +MATE_MIXER_IS_STREAM_CLASS MATE_MIXER_STREAM -MATE_MIXER_STREAM_GET_INTERFACE +MATE_MIXER_STREAM_CLASS +MATE_MIXER_STREAM_GET_CLASS MATE_MIXER_TYPE_STREAM mate_mixer_stream_get_type
+ +
+matemixer-stream-control +MateMixerStreamControl +MATE_MIXER_INFINITY +MateMixerStreamControlFlags +MateMixerStreamControlRole +MateMixerStreamControlMediaRole +MateMixerChannelPosition +MateMixerStreamControl +MateMixerStreamControlClass +mate_mixer_stream_control_get_name +mate_mixer_stream_control_get_label +mate_mixer_stream_control_get_flags +mate_mixer_stream_control_get_role +mate_mixer_stream_control_get_media_role +mate_mixer_stream_control_get_app_info +mate_mixer_stream_control_get_stream +mate_mixer_stream_control_set_stream +mate_mixer_stream_control_get_mute +mate_mixer_stream_control_set_mute +mate_mixer_stream_control_get_num_channels +mate_mixer_stream_control_get_volume +mate_mixer_stream_control_set_volume +mate_mixer_stream_control_get_decibel +mate_mixer_stream_control_set_decibel +mate_mixer_stream_control_has_channel_position +mate_mixer_stream_control_get_channel_position +mate_mixer_stream_control_get_channel_volume +mate_mixer_stream_control_set_channel_volume +mate_mixer_stream_control_get_channel_decibel +mate_mixer_stream_control_set_channel_decibel +mate_mixer_stream_control_get_balance +mate_mixer_stream_control_set_balance +mate_mixer_stream_control_get_fade +mate_mixer_stream_control_set_fade +mate_mixer_stream_control_get_monitor_enabled +mate_mixer_stream_control_set_monitor_enabled +mate_mixer_stream_control_get_min_volume +mate_mixer_stream_control_get_max_volume +mate_mixer_stream_control_get_normal_volume +mate_mixer_stream_control_get_base_volume +MateMixerStreamControlPrivate + +MATE_MIXER_IS_STREAM_CONTROL +MATE_MIXER_IS_STREAM_CONTROL_CLASS +MATE_MIXER_STREAM_CONTROL +MATE_MIXER_STREAM_CONTROL_CLASS +MATE_MIXER_STREAM_CONTROL_GET_CLASS +MATE_MIXER_TYPE_STREAM_CONTROL +mate_mixer_stream_control_get_type +
+ +
+matemixer-switch +MateMixerSwitch +MateMixerSwitchFlags +MateMixerSwitchRole +MateMixerSwitch +MateMixerSwitchClass +mate_mixer_switch_get_name +mate_mixer_switch_get_label +mate_mixer_switch_get_flags +mate_mixer_switch_get_role +mate_mixer_switch_get_option +mate_mixer_switch_list_options +mate_mixer_switch_get_active_option +mate_mixer_switch_set_active_option +MateMixerSwitchPrivate + +MATE_MIXER_IS_SWITCH +MATE_MIXER_IS_SWITCH_CLASS +MATE_MIXER_SWITCH +MATE_MIXER_SWITCH_CLASS +MATE_MIXER_SWITCH_GET_CLASS +MATE_MIXER_TYPE_SWITCH +mate_mixer_switch_get_type +
+ +
+matemixer-switch-option +MateMixerSwitchOption +MateMixerSwitchOption +MateMixerSwitchOptionClass +mate_mixer_switch_option_get_name +mate_mixer_switch_option_get_label +mate_mixer_switch_option_get_icon +MateMixerSwitchOptionPrivate + +MATE_MIXER_IS_SWITCH_OPTION +MATE_MIXER_IS_SWITCH_OPTION_CLASS +MATE_MIXER_SWITCH_OPTION +MATE_MIXER_SWITCH_OPTION_CLASS +MATE_MIXER_SWITCH_OPTION_GET_CLASS +MATE_MIXER_TYPE_SWITCH_OPTION +mate_mixer_switch_option_get_type +
+ +
+matemixer-toggle +MateMixerToggle +MateMixerToggle +MateMixerToggleClass +mate_mixer_toggle_get_state +mate_mixer_toggle_set_state +mate_mixer_toggle_get_state_option +MateMixerTogglePrivate + +MATE_MIXER_IS_TOGGLE +MATE_MIXER_IS_TOGGLE_CLASS +MATE_MIXER_TOGGLE +MATE_MIXER_TOGGLE_CLASS +MATE_MIXER_TOGGLE_GET_CLASS +MATE_MIXER_TYPE_TOGGLE +mate_mixer_toggle_get_type +
-- cgit v1.2.1 From 4f089f8489e292ced05a89ec7d761b9bc6533b84 Mon Sep 17 00:00:00 2001 From: Michal Ratajsky Date: Thu, 28 Aug 2014 23:39:33 +0200 Subject: Documentation additions and fixes --- docs/reference/Makefile.am | 3 +-- docs/reference/libmatemixer-sections.txt | 8 ++++++-- 2 files changed, 7 insertions(+), 4 deletions(-) (limited to 'docs/reference') diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 4a6e205..fb3db04 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -61,8 +61,7 @@ IGNORE_HFILES= \ matemixer-stream-private.h \ matemixer-switch-option-private.h \ matemixer-switch-private.h \ - matemixer-private.h \ - matemixer-types.h + matemixer-private.h # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png diff --git a/docs/reference/libmatemixer-sections.txt b/docs/reference/libmatemixer-sections.txt index 46e8a8d..2b901e5 100644 --- a/docs/reference/libmatemixer-sections.txt +++ b/docs/reference/libmatemixer-sections.txt @@ -9,6 +9,7 @@ LIBMATEMIXER_CHECK_VERSION
matemixer-app-info MateMixerAppInfo +MateMixerAppInfo mate_mixer_app_info_get_name mate_mixer_app_info_get_id mate_mixer_app_info_get_version @@ -16,6 +17,7 @@ mate_mixer_app_info_get_icon MATE_MIXER_APP_INFO MATE_MIXER_TYPE_APP_INFO + mate_mixer_app_info_get_type
@@ -50,7 +52,6 @@ mate_mixer_context_set_default_output_stream mate_mixer_context_get_backend_name mate_mixer_context_get_backend_type mate_mixer_context_get_backend_flags -MateMixerContextPrivate MATE_MIXER_CONTEXT MATE_MIXER_CONTEXT_CLASS @@ -59,6 +60,8 @@ MATE_MIXER_IS_CONTEXT MATE_MIXER_IS_CONTEXT_CLASS MATE_MIXER_TYPE_CONTEXT mate_mixer_context_get_type + +MateMixerContextPrivate
@@ -73,7 +76,6 @@ mate_mixer_device_get_stream mate_mixer_device_get_switch mate_mixer_device_list_streams mate_mixer_device_list_switches -MateMixerDevicePrivate MATE_MIXER_DEVICE MATE_MIXER_DEVICE_CLASS @@ -82,6 +84,8 @@ MATE_MIXER_IS_DEVICE MATE_MIXER_IS_DEVICE_CLASS MATE_MIXER_TYPE_DEVICE mate_mixer_device_get_type + +MateMixerDevicePrivate
-- cgit v1.2.1 From 1a9410a38aebb6ce05d43433c020e198416761df Mon Sep 17 00:00:00 2001 From: Michal Ratajsky Date: Fri, 5 Sep 2014 16:36:05 +0200 Subject: Documentation additions and fixes --- docs/reference/libmatemixer-sections.txt | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) (limited to 'docs/reference') diff --git a/docs/reference/libmatemixer-sections.txt b/docs/reference/libmatemixer-sections.txt index 2b901e5..d3545f6 100644 --- a/docs/reference/libmatemixer-sections.txt +++ b/docs/reference/libmatemixer-sections.txt @@ -59,9 +59,9 @@ MATE_MIXER_CONTEXT_GET_CLASS MATE_MIXER_IS_CONTEXT MATE_MIXER_IS_CONTEXT_CLASS MATE_MIXER_TYPE_CONTEXT -mate_mixer_context_get_type MateMixerContextPrivate +mate_mixer_context_get_type
@@ -83,9 +83,9 @@ MATE_MIXER_DEVICE_GET_CLASS MATE_MIXER_IS_DEVICE MATE_MIXER_IS_DEVICE_CLASS MATE_MIXER_TYPE_DEVICE -mate_mixer_device_get_type MateMixerDevicePrivate +mate_mixer_device_get_type
@@ -98,6 +98,7 @@ MATE_MIXER_IS_STORED_CONTROL MATE_MIXER_STORED_CONTROL MATE_MIXER_STORED_CONTROL_GET_INTERFACE MATE_MIXER_TYPE_STORED_CONTROL + mate_mixer_stored_control_get_type
@@ -116,7 +117,6 @@ mate_mixer_stream_get_switch mate_mixer_stream_get_default_control mate_mixer_stream_list_controls mate_mixer_stream_list_switches -MateMixerStreamPrivate MATE_MIXER_IS_STREAM MATE_MIXER_IS_STREAM_CLASS @@ -124,6 +124,8 @@ MATE_MIXER_STREAM MATE_MIXER_STREAM_CLASS MATE_MIXER_STREAM_GET_CLASS MATE_MIXER_TYPE_STREAM + +MateMixerStreamPrivate mate_mixer_stream_get_type @@ -168,7 +170,6 @@ mate_mixer_stream_control_get_min_volume mate_mixer_stream_control_get_max_volume mate_mixer_stream_control_get_normal_volume mate_mixer_stream_control_get_base_volume -MateMixerStreamControlPrivate MATE_MIXER_IS_STREAM_CONTROL MATE_MIXER_IS_STREAM_CONTROL_CLASS @@ -176,6 +177,8 @@ MATE_MIXER_STREAM_CONTROL MATE_MIXER_STREAM_CONTROL_CLASS MATE_MIXER_STREAM_CONTROL_GET_CLASS MATE_MIXER_TYPE_STREAM_CONTROL + +MateMixerStreamControlPrivate mate_mixer_stream_control_get_type @@ -194,7 +197,6 @@ mate_mixer_switch_get_option mate_mixer_switch_list_options mate_mixer_switch_get_active_option mate_mixer_switch_set_active_option -MateMixerSwitchPrivate MATE_MIXER_IS_SWITCH MATE_MIXER_IS_SWITCH_CLASS @@ -202,6 +204,8 @@ MATE_MIXER_SWITCH MATE_MIXER_SWITCH_CLASS MATE_MIXER_SWITCH_GET_CLASS MATE_MIXER_TYPE_SWITCH + +MateMixerSwitchPrivate mate_mixer_switch_get_type @@ -213,7 +217,6 @@ MateMixerSwitchOptionClass mate_mixer_switch_option_get_name mate_mixer_switch_option_get_label mate_mixer_switch_option_get_icon -MateMixerSwitchOptionPrivate MATE_MIXER_IS_SWITCH_OPTION MATE_MIXER_IS_SWITCH_OPTION_CLASS @@ -221,6 +224,8 @@ MATE_MIXER_SWITCH_OPTION MATE_MIXER_SWITCH_OPTION_CLASS MATE_MIXER_SWITCH_OPTION_GET_CLASS MATE_MIXER_TYPE_SWITCH_OPTION + +MateMixerSwitchOptionPrivate mate_mixer_switch_option_get_type @@ -232,7 +237,6 @@ MateMixerToggleClass mate_mixer_toggle_get_state mate_mixer_toggle_set_state mate_mixer_toggle_get_state_option -MateMixerTogglePrivate MATE_MIXER_IS_TOGGLE MATE_MIXER_IS_TOGGLE_CLASS @@ -240,5 +244,7 @@ MATE_MIXER_TOGGLE MATE_MIXER_TOGGLE_CLASS MATE_MIXER_TOGGLE_GET_CLASS MATE_MIXER_TYPE_TOGGLE + +MateMixerTogglePrivate mate_mixer_toggle_get_type -- cgit v1.2.1 From 3c4f6e0bfbc6fdca6f0e18c83a02fbfd050d1083 Mon Sep 17 00:00:00 2001 From: Michal Ratajsky Date: Sun, 7 Sep 2014 23:07:49 +0200 Subject: Turn MateMixerStoredControl into an abstract class --- docs/reference/libmatemixer-sections.txt | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'docs/reference') diff --git a/docs/reference/libmatemixer-sections.txt b/docs/reference/libmatemixer-sections.txt index d3545f6..911d43d 100644 --- a/docs/reference/libmatemixer-sections.txt +++ b/docs/reference/libmatemixer-sections.txt @@ -91,14 +91,18 @@ mate_mixer_device_get_type
matemixer-stored-control MateMixerStoredControl -MateMixerStoredControlInterface +MateMixerStoredControl +MateMixerStoredControlClass mate_mixer_stored_control_get_direction -MATE_MIXER_IS_STORED_CONTROL MATE_MIXER_STORED_CONTROL -MATE_MIXER_STORED_CONTROL_GET_INTERFACE +MATE_MIXER_STORED_CONTROL_CLASS +MATE_MIXER_STORED_CONTROL_GET_CLASS +MATE_MIXER_IS_STORED_CONTROL +MATE_MIXER_IS_STORED_CONTROL_CLASS MATE_MIXER_TYPE_STORED_CONTROL +MateMixerStoredControlPrivate mate_mixer_stored_control_get_type
-- cgit v1.2.1