summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichal Ratajsky <[email protected]>2014-08-20 22:49:43 +0200
committerMichal Ratajsky <[email protected]>2014-08-20 22:49:43 +0200
commit757af51e610632bfbe507f3b644014467b417d61 (patch)
tree4dfa5006146c115d0f6176e905a09ee92c5864c0 /docs
parent73fda4e84189528df38d5a37dec90621e2060bc0 (diff)
downloadlibmatemixer-757af51e610632bfbe507f3b644014467b417d61.tar.bz2
libmatemixer-757af51e610632bfbe507f3b644014467b417d61.tar.xz
Corrections to gtk-doc
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/Makefile.am10
-rw-r--r--docs/reference/libmatemixer-docs.xml11
-rw-r--r--docs/reference/libmatemixer-sections.txt339
3 files changed, 208 insertions, 152 deletions
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 @@
<chapter>
<title>API Reference</title>
<xi:include href="xml/matemixer.xml"/>
- <xi:include href="xml/matemixer-client-stream.xml"/>
- <xi:include href="xml/matemixer-control.xml"/>
+ <xi:include href="xml/matemixer-app-info.xml"/>
+ <xi:include href="xml/matemixer-context.xml"/>
<xi:include href="xml/matemixer-device.xml"/>
- <xi:include href="xml/matemixer-device-profile.xml"/>
- <xi:include href="xml/matemixer-port.xml"/>
<xi:include href="xml/matemixer-stream.xml"/>
+ <xi:include href="xml/matemixer-stream-control.xml"/>
+ <xi:include href="xml/matemixer-stored-control.xml"/>
+ <xi:include href="xml/matemixer-switch.xml"/>
+ <xi:include href="xml/matemixer-switch-option.xml"/>
+ <xi:include href="xml/matemixer-toggle.xml"/>
</chapter>
<index id="api-index-full">
<title>API Index</title>
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 @@
<SECTION>
<FILE>matemixer</FILE>
+<TITLE>MateMixer</TITLE>
mate_mixer_init
-mate_mixer_deinit
mate_mixer_is_initialized
LIBMATEMIXER_CHECK_VERSION
</SECTION>
<SECTION>
-<FILE>matemixer-client-stream</FILE>
-<TITLE>MateMixerClientStream</TITLE>
-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
+<FILE>matemixer-app-info</FILE>
+<TITLE>MateMixerAppInfo</TITLE>
+mate_mixer_app_info_get_name
+mate_mixer_app_info_get_id
+mate_mixer_app_info_get_version
+mate_mixer_app_info_get_icon
<SUBSECTION Standard>
-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
</SECTION>
<SECTION>
-<FILE>matemixer-control</FILE>
-<TITLE>MateMixerControl</TITLE>
+<FILE>matemixer-context</FILE>
+<TITLE>MateMixerContext</TITLE>
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
<SUBSECTION Standard>
-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
-<SUBSECTION Private>
-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
</SECTION>
<SECTION>
<FILE>matemixer-device</FILE>
<TITLE>MateMixerDevice</TITLE>
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
<SUBSECTION Standard>
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
</SECTION>
<SECTION>
-<FILE>matemixer-device-profile</FILE>
-<TITLE>MateMixerDeviceProfile</TITLE>
-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
+<FILE>matemixer-stored-control</FILE>
+<TITLE>MateMixerStoredControl</TITLE>
+MateMixerStoredControlInterface
+mate_mixer_stored_control_get_direction
<SUBSECTION Standard>
-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
-<SUBSECTION Private>
-MateMixerDeviceProfilePrivate
-</SECTION>
-
-<SECTION>
-<FILE>matemixer-port</FILE>
-<TITLE>MateMixerPort</TITLE>
-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
-<SUBSECTION Standard>
-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
-<SUBSECTION Private>
-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
</SECTION>
<SECTION>
<FILE>matemixer-stream</FILE>
<TITLE>MateMixerStream</TITLE>
-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
<SUBSECTION Standard>
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
</SECTION>
+
+<SECTION>
+<FILE>matemixer-stream-control</FILE>
+<TITLE>MateMixerStreamControl</TITLE>
+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
+<SUBSECTION Standard>
+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
+</SECTION>
+
+<SECTION>
+<FILE>matemixer-switch</FILE>
+<TITLE>MateMixerSwitch</TITLE>
+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
+<SUBSECTION Standard>
+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
+</SECTION>
+
+<SECTION>
+<FILE>matemixer-switch-option</FILE>
+<TITLE>MateMixerSwitchOption</TITLE>
+MateMixerSwitchOption
+MateMixerSwitchOptionClass
+mate_mixer_switch_option_get_name
+mate_mixer_switch_option_get_label
+mate_mixer_switch_option_get_icon
+MateMixerSwitchOptionPrivate
+<SUBSECTION Standard>
+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
+</SECTION>
+
+<SECTION>
+<FILE>matemixer-toggle</FILE>
+<TITLE>MateMixerToggle</TITLE>
+MateMixerToggle
+MateMixerToggleClass
+mate_mixer_toggle_get_state
+mate_mixer_toggle_set_state
+mate_mixer_toggle_get_state_option
+MateMixerTogglePrivate
+<SUBSECTION Standard>
+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
+</SECTION>