summaryrefslogtreecommitdiff
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
parent73fda4e84189528df38d5a37dec90621e2060bc0 (diff)
downloadlibmatemixer-757af51e610632bfbe507f3b644014467b417d61.tar.bz2
libmatemixer-757af51e610632bfbe507f3b644014467b417d61.tar.xz
Corrections to gtk-doc
-rw-r--r--docs/reference/Makefile.am10
-rw-r--r--docs/reference/libmatemixer-docs.xml11
-rw-r--r--docs/reference/libmatemixer-sections.txt339
-rw-r--r--libmatemixer/matemixer-app-info.c14
-rw-r--r--libmatemixer/matemixer-context.h3
-rw-r--r--libmatemixer/matemixer-device.h3
-rw-r--r--libmatemixer/matemixer-enums.h45
-rw-r--r--libmatemixer/matemixer-stored-control.h3
-rw-r--r--libmatemixer/matemixer-stream-control.c15
-rw-r--r--libmatemixer/matemixer-stream-control.h3
-rw-r--r--libmatemixer/matemixer-stream.c2
-rw-r--r--libmatemixer/matemixer-stream.h3
-rw-r--r--libmatemixer/matemixer-switch-option.c5
-rw-r--r--libmatemixer/matemixer-switch-option.h3
-rw-r--r--libmatemixer/matemixer-switch.c2
-rw-r--r--libmatemixer/matemixer-switch.h3
-rw-r--r--libmatemixer/matemixer-toggle.c2
-rw-r--r--libmatemixer/matemixer-toggle.h3
18 files changed, 294 insertions, 175 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>
diff --git a/libmatemixer/matemixer-app-info.c b/libmatemixer/matemixer-app-info.c
index 369f148..65cba6c 100644
--- a/libmatemixer/matemixer-app-info.c
+++ b/libmatemixer/matemixer-app-info.c
@@ -18,13 +18,19 @@
#include "matemixer-app-info.h"
#include "matemixer-app-info-private.h"
+/**
+ * SECTION:matemixer-app-info
+ * @short_description: Application information
+ * @include: libmatemixer/matemixer.h
+ */
+
G_DEFINE_BOXED_TYPE (MateMixerAppInfo, mate_mixer_app_info,
_mate_mixer_app_info_copy,
_mate_mixer_app_info_free)
/**
* mate_mixer_app_info_get_name:
- * @device: a #MateMixerAppInfo
+ * @info: a #MateMixerAppInfo
*/
const gchar *
mate_mixer_app_info_get_name (MateMixerAppInfo *info)
@@ -36,7 +42,7 @@ mate_mixer_app_info_get_name (MateMixerAppInfo *info)
/**
* mate_mixer_app_info_get_id:
- * @device: a #MateMixerAppInfo
+ * @info: a #MateMixerAppInfo
*/
const gchar *
mate_mixer_app_info_get_id (MateMixerAppInfo *info)
@@ -48,7 +54,7 @@ mate_mixer_app_info_get_id (MateMixerAppInfo *info)
/**
* mate_mixer_app_info_get_version:
- * @device: a #MateMixerAppInfo
+ * @info: a #MateMixerAppInfo
*/
const gchar *
mate_mixer_app_info_get_version (MateMixerAppInfo *info)
@@ -60,7 +66,7 @@ mate_mixer_app_info_get_version (MateMixerAppInfo *info)
/**
* mate_mixer_app_info_get_icon:
- * @device: a #MateMixerAppInfo
+ * @info: a #MateMixerAppInfo
*/
const gchar *
mate_mixer_app_info_get_icon (MateMixerAppInfo *info)
diff --git a/libmatemixer/matemixer-context.h b/libmatemixer/matemixer-context.h
index 30d9363..19d153f 100644
--- a/libmatemixer/matemixer-context.h
+++ b/libmatemixer/matemixer-context.h
@@ -58,8 +58,9 @@ struct _MateMixerContext
/**
* MateMixerContextClass:
+ * @parent_class: The parent class.
*
- * The class structure of #MateMixerContext.
+ * The class structure for #MateMixerContext.
*/
struct _MateMixerContextClass
{
diff --git a/libmatemixer/matemixer-device.h b/libmatemixer/matemixer-device.h
index 51d2a14..49ac347 100644
--- a/libmatemixer/matemixer-device.h
+++ b/libmatemixer/matemixer-device.h
@@ -57,8 +57,9 @@ struct _MateMixerDevice
/**
* MateMixerDeviceClass:
+ * @parent_class: The parent class.
*
- * The class structure of #MateMixerDevice.
+ * The class structure for #MateMixerDevice.
*/
struct _MateMixerDeviceClass
{
diff --git a/libmatemixer/matemixer-enums.h b/libmatemixer/matemixer-enums.h
index 18bbbcf..97d2f26 100644
--- a/libmatemixer/matemixer-enums.h
+++ b/libmatemixer/matemixer-enums.h
@@ -48,7 +48,9 @@ typedef enum {
* will be the first one to try unless you select a specific backend
* to connect to.
* @MATE_MIXER_BACKEND_ALSA:
+ * The Advanced Linux Sound Architecture sound system.
* @MATE_MIXER_BACKEND_OSS:
+ * The Open Sound System.
* @MATE_MIXER_BACKEND_NULL:
* Fallback backend which never fails to initialize, but provides no
* functionality. This backend has the lowest priority and will be used
@@ -65,17 +67,32 @@ typedef enum {
/**
* MateMixerBackendFlags:
+ * @MATE_MIXER_BACKEND_NO_FLAGS:
+ * No flags.
+ * @MATE_MIXER_BACKEND_HAS_APPLICATION_CONTROLS:
+ * The backend includes support for application stream controls.
+ * @MATE_MIXER_BACKEND_CAN_SET_DEFAULT_INPUT_STREAM:
+ * The backend is able to change the current default input stream using
+ * the mate_mixer_context_set_default_input_stream() function.
+ * @MATE_MIXER_BACKEND_CAN_SET_DEFAULT_OUTPUT_STREAM:
+ * The backend is able to change the current default output stream using
+ * the mate_mixer_context_set_default_output_stream() function.
*/
-
typedef enum { /*< flags >*/
- MATE_MIXER_BACKEND_NO_FLAGS = 0,
- MATE_MIXER_BACKEND_HAS_APPLICATION_CONTROLS,
- MATE_MIXER_BACKEND_CAN_SET_DEFAULT_INPUT_STREAM,
- MATE_MIXER_BACKEND_CAN_SET_DEFAULT_OUTPUT_STREAM
+ MATE_MIXER_BACKEND_NO_FLAGS = 0,
+ MATE_MIXER_BACKEND_HAS_APPLICATION_CONTROLS = 1 << 0,
+ MATE_MIXER_BACKEND_CAN_SET_DEFAULT_INPUT_STREAM = 1 << 1,
+ MATE_MIXER_BACKEND_CAN_SET_DEFAULT_OUTPUT_STREAM = 1 << 2
} MateMixerBackendFlags;
/**
* MateMixerDirection:
+ * @MATE_MIXER_DIRECTION_UNKNOWN:
+ * Unknown direction.
+ * @MATE_MIXER_DIRECTION_INPUT:
+ * Input direction (recording).
+ * @MATE_MIXER_DIRECTION_OUTPUT:
+ * Output direction (playback).
*/
typedef enum {
MATE_MIXER_DIRECTION_UNKNOWN,
@@ -86,13 +103,21 @@ typedef enum {
/**
* MateMixerStreamControlFlags:
* @MATE_MIXER_STREAM_CONTROL_NO_FLAGS:
- * @MATE_MIXER_STREAM_CONTROL_HAS_MUTE:
- * @MATE_MIXER_STREAM_CONTROL_HAS_VOLUME:
- * @MATE_MIXER_STREAM_CONTROL_HAS_DECIBEL:
- * @MATE_MIXER_STREAM_CONTROL_HAS_FLAT_VOLUME:
- * @MATE_MIXER_STREAM_CONTROL_CAN_SET_VOLUME:
+ * No flags.
+ * @MATE_MIXER_STREAM_CONTROL_MUTE_READABLE:
+ * The stream control includes a mute toggle and allows reading the mute state.
+ * @MATE_MIXER_STREAM_CONTROL_MUTE_WRITABLE:
+ * @MATE_MIXER_STREAM_CONTROL_VOLUME_READABLE:
+ * @MATE_MIXER_STREAM_CONTROL_VOLUME_WRITABLE:
* @MATE_MIXER_STREAM_CONTROL_CAN_BALANCE:
* @MATE_MIXER_STREAM_CONTROL_CAN_FADE:
+ * @MATE_MIXER_STREAM_CONTROL_MOVABLE:
+ * It is possible to move the stream control to a different stream using the
+ * mate_mixer_stream_control_set_stream() function. See the function description
+ * for details.
+ * @MATE_MIXER_STREAM_CONTROL_HAS_DECIBEL:
+ * @MATE_MIXER_STREAM_CONTROL_HAS_MONITOR:
+ * @MATE_MIXER_STREAM_CONTROL_STORED:
*/
typedef enum {
MATE_MIXER_STREAM_CONTROL_NO_FLAGS = 0,
diff --git a/libmatemixer/matemixer-stored-control.h b/libmatemixer/matemixer-stored-control.h
index 0c9c982..09731ef 100644
--- a/libmatemixer/matemixer-stored-control.h
+++ b/libmatemixer/matemixer-stored-control.h
@@ -39,8 +39,9 @@ typedef struct _MateMixerStoredControlInterface MateMixerStoredControlInterface
/**
* MateMixerStoredControlInterface:
+ * @parent_iface: The parent interface.
*
- * The interface structure of #MateMixerStoredControl.
+ * The interface structure for #MateMixerStoredControl.
*/
struct _MateMixerStoredControlInterface
{
diff --git a/libmatemixer/matemixer-stream-control.c b/libmatemixer/matemixer-stream-control.c
index ad0960e..d2c756c 100644
--- a/libmatemixer/matemixer-stream-control.c
+++ b/libmatemixer/matemixer-stream-control.c
@@ -399,6 +399,7 @@ mate_mixer_stream_control_get_stream (MateMixerStreamControl *control)
/**
* mate_mixer_stream_control_set_stream:
* @control: a #MateMixerStreamControl
+ * @stream: a #MateMixerStream
*/
gboolean
mate_mixer_stream_control_set_stream (MateMixerStreamControl *control,
@@ -435,6 +436,7 @@ mate_mixer_stream_control_get_mute (MateMixerStreamControl *control)
/**
* mate_mixer_stream_control_set_mute:
* @control: a #MateMixerStreamControl
+ * @mute: the mute toggle state to set
*/
gboolean
mate_mixer_stream_control_set_mute (MateMixerStreamControl *control, gboolean mute)
@@ -501,6 +503,7 @@ mate_mixer_stream_control_get_volume (MateMixerStreamControl *control)
/**
* mate_mixer_stream_control_set_volume:
* @control: a #MateMixerStreamControl
+ * @volume: the volume to set
*/
gboolean
mate_mixer_stream_control_set_volume (MateMixerStreamControl *control, guint volume)
@@ -541,6 +544,7 @@ mate_mixer_stream_control_get_decibel (MateMixerStreamControl *control)
/**
* mate_mixer_stream_control_set_decibel:
* @control: a #MateMixerStreamControl
+ * @decibel: the volume to set in decibels
*/
gboolean
mate_mixer_stream_control_set_decibel (MateMixerStreamControl *control, gdouble decibel)
@@ -562,6 +566,7 @@ mate_mixer_stream_control_set_decibel (MateMixerStreamControl *control, gdouble
/**
* mate_mixer_stream_control_has_channel_position:
* @control: a #MateMixerStreamControl
+ * @position: to channel position to check
*/
gboolean
mate_mixer_stream_control_has_channel_position (MateMixerStreamControl *control,
@@ -582,6 +587,7 @@ mate_mixer_stream_control_has_channel_position (MateMixerStreamControl *contro
/**
* mate_mixer_stream_control_get_channel_position:
* @control: a #MateMixerStreamControl
+ * @channel: a channel index
*/
MateMixerChannelPosition
mate_mixer_stream_control_get_channel_position (MateMixerStreamControl *control, guint channel)
@@ -601,6 +607,7 @@ mate_mixer_stream_control_get_channel_position (MateMixerStreamControl *control,
/**
* mate_mixer_stream_control_get_channel_volume:
* @control: a #MateMixerStreamControl
+ * @channel: a channel index
*/
guint
mate_mixer_stream_control_get_channel_volume (MateMixerStreamControl *control, guint channel)
@@ -621,6 +628,8 @@ mate_mixer_stream_control_get_channel_volume (MateMixerStreamControl *control, g
/**
* mate_mixer_stream_control_set_channel_volume:
* @control: a #MateMixerStreamControl
+ * @channel: a channel index
+ * @volume: the volume to set
*/
gboolean
mate_mixer_stream_control_set_channel_volume (MateMixerStreamControl *control,
@@ -643,6 +652,7 @@ mate_mixer_stream_control_set_channel_volume (MateMixerStreamControl *control,
/**
* mate_mixer_stream_control_get_channel_decibel:
* @control: a #MateMixerStreamControl
+ * @channel: a channel index
*/
gdouble
mate_mixer_stream_control_get_channel_decibel (MateMixerStreamControl *control, guint channel)
@@ -663,6 +673,8 @@ mate_mixer_stream_control_get_channel_decibel (MateMixerStreamControl *control,
/**
* mate_mixer_stream_control_set_channel_decibel:
* @control: a #MateMixerStreamControl
+ * @channel: a channel index
+ * @decibel: the volume to set in decibels
*/
gboolean
mate_mixer_stream_control_set_channel_decibel (MateMixerStreamControl *control,
@@ -700,6 +712,7 @@ mate_mixer_stream_control_get_balance (MateMixerStreamControl *control)
/**
* mate_mixer_stream_control_set_balance:
* @control: a #MateMixerStreamControl
+ * @balance: the balance value
*/
gboolean
mate_mixer_stream_control_set_balance (MateMixerStreamControl *control, gfloat balance)
@@ -738,6 +751,7 @@ mate_mixer_stream_control_get_fade (MateMixerStreamControl *control)
/**
* mate_mixer_stream_control_set_fade:
* @control: a #MateMixerStreamControl
+ * @fade: the fade value
*/
gboolean
mate_mixer_stream_control_set_fade (MateMixerStreamControl *control, gfloat fade)
@@ -780,6 +794,7 @@ mate_mixer_stream_control_get_monitor_enabled (MateMixerStreamControl *control)
/**
* mate_mixer_stream_control_set_monitor_enabled:
* @control: a #MateMixerStreamControl
+ * @enabled: a boolean value
*/
gboolean
mate_mixer_stream_control_set_monitor_enabled (MateMixerStreamControl *control, gboolean enabled)
diff --git a/libmatemixer/matemixer-stream-control.h b/libmatemixer/matemixer-stream-control.h
index 2adf97f..bcedd24 100644
--- a/libmatemixer/matemixer-stream-control.h
+++ b/libmatemixer/matemixer-stream-control.h
@@ -65,8 +65,9 @@ struct _MateMixerStreamControl
/**
* MateMixerStreamControlClass:
+ * @parent_class: The parent class.
*
- * The class structure of #MateMixerStreamControl.
+ * The class structure for #MateMixerStreamControl.
*/
struct _MateMixerStreamControlClass
{
diff --git a/libmatemixer/matemixer-stream.c b/libmatemixer/matemixer-stream.c
index aa1afd7..a4e2de4 100644
--- a/libmatemixer/matemixer-stream.c
+++ b/libmatemixer/matemixer-stream.c
@@ -355,6 +355,7 @@ mate_mixer_stream_get_device (MateMixerStream *stream)
/**
* mate_mixer_stream_get_control:
* @stream: a #MateMixerStream
+ * @name: the name of a stream control
*/
MateMixerStreamControl *
mate_mixer_stream_get_control (MateMixerStream *stream, const gchar *name)
@@ -368,6 +369,7 @@ mate_mixer_stream_get_control (MateMixerStream *stream, const gchar *name)
/**
* mate_mixer_stream_get_switch:
* @stream: a #MateMixerStream
+ * @name: the name of a stream switch
*/
MateMixerSwitch *
mate_mixer_stream_get_switch (MateMixerStream *stream, const gchar *name)
diff --git a/libmatemixer/matemixer-stream.h b/libmatemixer/matemixer-stream.h
index c030196..969095b 100644
--- a/libmatemixer/matemixer-stream.h
+++ b/libmatemixer/matemixer-stream.h
@@ -58,8 +58,9 @@ struct _MateMixerStream
/**
* MateMixerStreamClass:
+ * @parent_class: The parent class.
*
- * The class structure of #MateMixerStream.
+ * The class structure for #MateMixerStream.
*/
struct _MateMixerStreamClass
{
diff --git a/libmatemixer/matemixer-switch-option.c b/libmatemixer/matemixer-switch-option.c
index fc0c5b6..b20f92b 100644
--- a/libmatemixer/matemixer-switch-option.c
+++ b/libmatemixer/matemixer-switch-option.c
@@ -22,7 +22,7 @@
#include "matemixer-switch-option-private.h"
/**
- * SECTION:matemixer-stream-switch-option
+ * SECTION:matemixer-switch-option
* @include: libmatemixer/matemixer.h
*/
@@ -182,6 +182,7 @@ mate_mixer_switch_option_finalize (GObject *object)
/**
* mate_mixer_switch_option_get_name:
+ * @option: a #MateMixerSwitchOption
*/
const gchar *
mate_mixer_switch_option_get_name (MateMixerSwitchOption *option)
@@ -193,6 +194,7 @@ mate_mixer_switch_option_get_name (MateMixerSwitchOption *option)
/**
* mate_mixer_switch_option_get_label:
+ * @option: a #MateMixerSwitchOption
*/
const gchar *
mate_mixer_switch_option_get_label (MateMixerSwitchOption *option)
@@ -204,6 +206,7 @@ mate_mixer_switch_option_get_label (MateMixerSwitchOption *option)
/**
* mate_mixer_switch_option_get_icon:
+ * @option: a #MateMixerSwitchOption
*/
const gchar *
mate_mixer_switch_option_get_icon (MateMixerSwitchOption *option)
diff --git a/libmatemixer/matemixer-switch-option.h b/libmatemixer/matemixer-switch-option.h
index ae87718..03f3608 100644
--- a/libmatemixer/matemixer-switch-option.h
+++ b/libmatemixer/matemixer-switch-option.h
@@ -57,8 +57,9 @@ struct _MateMixerSwitchOption
/**
* MateMixerSwitchOptionClass:
+ * @parent_class: The parent class.
*
- * The class structure of #MateMixerSwitchOption.
+ * The class structure for #MateMixerSwitchOption.
*/
struct _MateMixerSwitchOptionClass
{
diff --git a/libmatemixer/matemixer-switch.c b/libmatemixer/matemixer-switch.c
index 461b49e..e50d416 100644
--- a/libmatemixer/matemixer-switch.c
+++ b/libmatemixer/matemixer-switch.c
@@ -289,6 +289,7 @@ mate_mixer_switch_get_role (MateMixerSwitch *swtch)
/**
* mate_mixer_switch_get_option:
* @swtch: a #MateMixerSwitch
+ * @name: the name of an option
*/
MateMixerSwitchOption *
mate_mixer_switch_get_option (MateMixerSwitch *swtch, const gchar *name)
@@ -313,6 +314,7 @@ mate_mixer_switch_get_active_option (MateMixerSwitch *swtch)
/**
* mate_mixer_switch_set_active_option:
* @swtch: a #MateMixerSwitch
+ * @option: the #MateMixerSwitchOption to set as the active option
*/
gboolean
mate_mixer_switch_set_active_option (MateMixerSwitch *swtch,
diff --git a/libmatemixer/matemixer-switch.h b/libmatemixer/matemixer-switch.h
index 7f0109f..5ebbd32 100644
--- a/libmatemixer/matemixer-switch.h
+++ b/libmatemixer/matemixer-switch.h
@@ -58,8 +58,9 @@ struct _MateMixerSwitch
/**
* MateMixerSwitchClass:
+ * @parent_class: The parent class.
*
- * The class structure of #MateMixerSwitch.
+ * The class structure for #MateMixerSwitch.
*/
struct _MateMixerSwitchClass
{
diff --git a/libmatemixer/matemixer-toggle.c b/libmatemixer/matemixer-toggle.c
index 0db6e3b..43bb8ce 100644
--- a/libmatemixer/matemixer-toggle.c
+++ b/libmatemixer/matemixer-toggle.c
@@ -213,6 +213,7 @@ mate_mixer_toggle_get_state (MateMixerToggle *toggle)
/**
* mate_mixer_toggle_get_state_option:
* @toggle: a #MateMixerToggle
+ * @state: the state to retrieve
*/
MateMixerSwitchOption *
mate_mixer_toggle_get_state_option (MateMixerToggle *toggle, gboolean state)
@@ -228,6 +229,7 @@ mate_mixer_toggle_get_state_option (MateMixerToggle *toggle, gboolean state)
/**
* mate_mixer_toggle_set_state:
* @toggle: a #MateMixerToggle
+ * @state: the state to set
*/
gboolean
mate_mixer_toggle_set_state (MateMixerToggle *toggle, gboolean state)
diff --git a/libmatemixer/matemixer-toggle.h b/libmatemixer/matemixer-toggle.h
index 44946f7..09e8943 100644
--- a/libmatemixer/matemixer-toggle.h
+++ b/libmatemixer/matemixer-toggle.h
@@ -57,8 +57,9 @@ struct _MateMixerToggle
/**
* MateMixerToggleClass:
+ * @parent_class: The parent class.
*
- * The class structure of #MateMixerToggle.
+ * The class structure for #MateMixerToggle.
*/
struct _MateMixerToggleClass
{