From a1448acc5b6d191c8dc1383b25a92f382b6b0363 Mon Sep 17 00:00:00 2001 From: Giovanni Campagna Date: Fri, 19 Oct 2012 20:00:47 +0200 Subject: [PATCH] Fix introspection support Fix includes, comments and parameter names so that introspection builds without warnings. --- gvc-channel-bar.c | 6 ++++++ gvc-channel-bar.h | 1 + gvc-channel-map.c | 1 - gvc-mixer-card.c | 8 +++----- gvc-mixer-control.c | 18 ++++++------------ gvc-mixer-control.h | 2 +- gvc-mixer-event-role.c | 3 +-- gvc-mixer-sink-input.c | 1 - gvc-mixer-sink-input.h | 2 +- gvc-mixer-sink.c | 1 - gvc-mixer-sink.h | 2 +- gvc-mixer-source-output.c | 1 - gvc-mixer-source-output.h | 2 +- gvc-mixer-source.c | 1 - gvc-mixer-source.h | 2 +- gvc-mixer-stream.c | 4 ---- gvc-mixer-ui-device.c | 16 +++++++++++++--- gvc-mixer-ui-device.h | 28 ++++++++++++++-------------- 18 files changed, 49 insertions(+), 50 deletions(-) diff --git a/gvc-channel-bar.c b/gvc-channel-bar.c index 3d854c9..b9d4a6c 100644 --- a/gvc-channel-bar.c +++ b/gvc-channel-bar.c @@ -369,6 +369,12 @@ gvc_channel_bar_set_adjustment (GvcChannelBar *bar, g_object_notify (G_OBJECT (bar), "adjustment"); } +/** + * gvc_channel_bar_get_adjustment: + * @bar: + * + * Returns: (transfer none): + */ GtkAdjustment * gvc_channel_bar_get_adjustment (GvcChannelBar *bar) { diff --git a/gvc-channel-bar.h b/gvc-channel-bar.h index 0b607e8..5d036f2 100644 --- a/gvc-channel-bar.h +++ b/gvc-channel-bar.h @@ -22,6 +22,7 @@ #define __GVC_CHANNEL_BAR_H #include +#include G_BEGIN_DECLS diff --git a/gvc-channel-map.c b/gvc-channel-map.c index a2073fd..f008dd8 100644 --- a/gvc-channel-map.c +++ b/gvc-channel-map.c @@ -122,7 +122,6 @@ gvc_channel_map_get_mapping (const GvcChannelMap *map) /** * gvc_channel_map_has_position: (skip) - * * @map: * @position: * diff --git a/gvc-mixer-card.c b/gvc-mixer-card.c index a9b246f..c512c51 100644 --- a/gvc-mixer-card.c +++ b/gvc-mixer-card.c @@ -148,7 +148,6 @@ gvc_mixer_card_set_icon_name (GvcMixerCard *card, /** * gvc_mixer_card_get_profile: (skip) - * * @card: * * Returns: @@ -325,10 +324,9 @@ gvc_mixer_card_set_profiles (GvcMixerCard *card, /** * gvc_mixer_card_get_gicon: - * * @card: * - * Return value: (transfer full) (element-type GIcon): + * Return value: (transfer full): */ GIcon * gvc_mixer_card_get_gicon (GvcMixerCard *card) @@ -343,11 +341,11 @@ gvc_mixer_card_get_gicon (GvcMixerCard *card) /** * gvc_mixer_card_set_ports: - * @profiles: (transfer full) (element-type GvcMixerCardPort): + * @ports: (transfer full) (element-type GvcMixerCardPort): */ gboolean gvc_mixer_card_set_ports (GvcMixerCard *card, - GList *ports) + GList *ports) { g_return_val_if_fail (GVC_IS_MIXER_CARD (card), FALSE); g_return_val_if_fail (card->priv->ports == NULL, FALSE); diff --git a/gvc-mixer-control.c b/gvc-mixer-control.c index 34ddc0c..3492925 100644 --- a/gvc-mixer-control.c +++ b/gvc-mixer-control.c @@ -134,7 +134,6 @@ gvc_mixer_control_get_pa_context (GvcMixerControl *control) /** * gvc_mixer_control_get_event_sink_input: - * * @control: * * Returns: (transfer none): @@ -215,6 +214,7 @@ gvc_mixer_control_stream_restore_source_cb (pa_context *c, * gvc_mixer_control_lookup_device_from_stream: * @control: * @stream: + * * Returns: (transfer none): a #GvcUIDevice or %NULL */ GvcMixerUIDevice * @@ -364,7 +364,6 @@ gvc_mixer_control_set_default_source (GvcMixerControl *control, /** * gvc_mixer_control_get_default_sink: - * * @control: * * Returns: (transfer none): @@ -388,7 +387,6 @@ gvc_mixer_control_get_default_sink (GvcMixerControl *control) /** * gvc_mixer_control_get_default_source: - * * @control: * * Returns: (transfer none): @@ -420,7 +418,6 @@ gvc_mixer_control_lookup_id (GHashTable *hash_table, /** * gvc_mixer_control_lookup_stream_id: - * * @control: * @id: * @@ -437,7 +434,6 @@ gvc_mixer_control_lookup_stream_id (GvcMixerControl *control, /** * gvc_mixer_control_lookup_card_id: - * * @control: * @id: * @@ -456,6 +452,7 @@ gvc_mixer_control_lookup_card_id (GvcMixerControl *control, * gvc_mixer_control_lookup_output_id: * @control: * @id: + * * Returns: (transfer none): */ GvcMixerUIDevice * @@ -471,6 +468,7 @@ gvc_mixer_control_lookup_output_id (GvcMixerControl *control, * gvc_mixer_control_lookup_input_id: * @control: * @id: + * * Returns: (transfer none): */ GvcMixerUIDevice * @@ -486,6 +484,7 @@ gvc_mixer_control_lookup_input_id (GvcMixerControl *control, * gvc_mixer_control_get_stream_from_device: * @control: * @device: + * * Returns: (transfer none): */ GvcMixerStream * @@ -511,6 +510,7 @@ gvc_mixer_control_get_stream_from_device (GvcMixerControl *control, * @control: * @device: * @profile: Can be null if any profile present on this port is okay + * * Returns: This method will attempt to swap the profile on the card of * the device with given profile name. If successfull it will set the * preferred profile on that device so as we know the next time the user @@ -749,7 +749,6 @@ gvc_card_collate (GvcMixerCard *a, /** * gvc_mixer_control_get_cards: - * * @control: * * Returns: (transfer container) (element-type Gvc.MixerCard): @@ -786,7 +785,6 @@ gvc_stream_collate (GvcMixerStream *a, /** * gvc_mixer_control_get_streams: - * * @control: * * Returns: (transfer container) (element-type Gvc.MixerStream): @@ -807,7 +805,6 @@ gvc_mixer_control_get_streams (GvcMixerControl *control) /** * gvc_mixer_control_get_sinks: - * * @control: * * Returns: (transfer container) (element-type Gvc.MixerSink): @@ -828,7 +825,6 @@ gvc_mixer_control_get_sinks (GvcMixerControl *control) /** * gvc_mixer_control_get_sources: - * * @control: * * Returns: (transfer container) (element-type Gvc.MixerSource): @@ -849,7 +845,6 @@ gvc_mixer_control_get_sources (GvcMixerControl *control) /** * gvc_mixer_control_get_sink_inputs: - * * @control: * * Returns: (transfer container) (element-type Gvc.MixerSinkInput): @@ -870,7 +865,6 @@ gvc_mixer_control_get_sink_inputs (GvcMixerControl *control) /** * gvc_mixer_control_get_source_outputs: - * * @control: * * Returns: (transfer container) (element-type Gvc.MixerSourceOutput): @@ -1863,7 +1857,7 @@ card_num_streams_to_status (guint sinks, return ret; } -/** +/* * A utility method to gather which card profiles are relevant to the port . */ static GList * diff --git a/gvc-mixer-control.h b/gvc-mixer-control.h index e5e2f74..3f0ea2e 100644 --- a/gvc-mixer-control.h +++ b/gvc-mixer-control.h @@ -124,7 +124,7 @@ void gvc_mixer_control_change_output (Gvc void gvc_mixer_control_change_input (GvcMixerControl *control, GvcMixerUIDevice* input); GvcMixerStream* gvc_mixer_control_get_stream_from_device (GvcMixerControl *control, - GvcMixerUIDevice *dev); + GvcMixerUIDevice *device); gboolean gvc_mixer_control_change_profile_on_selected_device (GvcMixerControl *control, GvcMixerUIDevice *device, const gchar* profile); diff --git a/gvc-mixer-event-role.c b/gvc-mixer-event-role.c index 3646df2..65d18c7 100644 --- a/gvc-mixer-event-role.c +++ b/gvc-mixer-event-role.c @@ -210,9 +210,8 @@ gvc_mixer_event_role_finalize (GObject *object) /** * gvc_mixer_event_role_new: (skip) - * * @context: - * @index: + * @device: * @channel_map: * * Returns: diff --git a/gvc-mixer-sink-input.c b/gvc-mixer-sink-input.c index 03ba3b2..a527e01 100644 --- a/gvc-mixer-sink-input.c +++ b/gvc-mixer-sink-input.c @@ -142,7 +142,6 @@ gvc_mixer_sink_input_finalize (GObject *object) /** * gvc_mixer_sink_input_new: (skip) - * * @context: * @index: * @channel_map: diff --git a/gvc-mixer-sink-input.h b/gvc-mixer-sink-input.h index 8a4b714..17bf127 100644 --- a/gvc-mixer-sink-input.h +++ b/gvc-mixer-sink-input.h @@ -50,7 +50,7 @@ GType gvc_mixer_sink_input_get_type (void); GvcMixerStream * gvc_mixer_sink_input_new (pa_context *context, guint index, - GvcChannelMap *map); + GvcChannelMap *channel_map); G_END_DECLS diff --git a/gvc-mixer-sink.c b/gvc-mixer-sink.c index 78c3c68..4641435 100644 --- a/gvc-mixer-sink.c +++ b/gvc-mixer-sink.c @@ -171,7 +171,6 @@ gvc_mixer_sink_finalize (GObject *object) /** * gvc_mixer_sink_new: (skip) - * * @context: * @index: * @channel_map: diff --git a/gvc-mixer-sink.h b/gvc-mixer-sink.h index 2a4a4ba..3fbe291 100644 --- a/gvc-mixer-sink.h +++ b/gvc-mixer-sink.h @@ -50,7 +50,7 @@ GType gvc_mixer_sink_get_type (void); GvcMixerStream * gvc_mixer_sink_new (pa_context *context, guint index, - GvcChannelMap *map); + GvcChannelMap *channel_map); G_END_DECLS diff --git a/gvc-mixer-source-output.c b/gvc-mixer-source-output.c index 536487b..9b18e51 100644 --- a/gvc-mixer-source-output.c +++ b/gvc-mixer-source-output.c @@ -97,7 +97,6 @@ gvc_mixer_source_output_finalize (GObject *object) /** * gvc_mixer_source_output_new: (skip) - * * @context: * @index: * @channel_map: diff --git a/gvc-mixer-source-output.h b/gvc-mixer-source-output.h index 2283e3b..4d9a6d6 100644 --- a/gvc-mixer-source-output.h +++ b/gvc-mixer-source-output.h @@ -50,7 +50,7 @@ GType gvc_mixer_source_output_get_type (void); GvcMixerStream * gvc_mixer_source_output_new (pa_context *context, guint index, - GvcChannelMap *map); + GvcChannelMap *channel_map); G_END_DECLS diff --git a/gvc-mixer-source.c b/gvc-mixer-source.c index dd2d0b4..7c6b2ba 100644 --- a/gvc-mixer-source.c +++ b/gvc-mixer-source.c @@ -171,7 +171,6 @@ gvc_mixer_source_finalize (GObject *object) /** * gvc_mixer_source_new: (skip) - * * @context: * @index: * @channel_map: diff --git a/gvc-mixer-source.h b/gvc-mixer-source.h index 503f1b5..bdffe8c 100644 --- a/gvc-mixer-source.h +++ b/gvc-mixer-source.h @@ -50,7 +50,7 @@ GType gvc_mixer_source_get_type (void); GvcMixerStream * gvc_mixer_source_new (pa_context *context, guint index, - GvcChannelMap *map); + GvcChannelMap *channel_map); G_END_DECLS diff --git a/gvc-mixer-stream.c b/gvc-mixer-stream.c index 0a5663e..5a5c8e6 100644 --- a/gvc-mixer-stream.c +++ b/gvc-mixer-stream.c @@ -132,7 +132,6 @@ gvc_mixer_stream_get_channel_map (GvcMixerStream *stream) /** * gvc_mixer_stream_get_volume: - * * @stream: * * Returns: (type guint32) (transfer none): @@ -156,7 +155,6 @@ gvc_mixer_stream_get_decibel (GvcMixerStream *stream) /** * gvc_mixer_stream_set_volume: - * * @stream: * @volume: (type guint32): * @@ -442,7 +440,6 @@ gvc_mixer_stream_set_sysfs_path (GvcMixerStream *stream, /** * gvc_mixer_stream_get_base_volume: - * * @stream: * * Returns: (type guint32) (transfer none): @@ -457,7 +454,6 @@ gvc_mixer_stream_get_base_volume (GvcMixerStream *stream) /** * gvc_mixer_stream_set_base_volume: - * * @stream: * @base_volume: (type guint32): * diff --git a/gvc-mixer-ui-device.c b/gvc-mixer-ui-device.c index 6f35990..a0d6b16 100644 --- a/gvc-mixer-ui-device.c +++ b/gvc-mixer-ui-device.c @@ -378,8 +378,7 @@ add_canonical_names_of_profiles (GvcMixerUIDevice *device, /** * gvc_mixer_ui_device_set_profiles: - * - * @in_profiles: a list of GvcMixerCardProfile + * @in_profiles: (element-type Gvc.MixerCardProfile): a list of GvcMixerCardProfile * * Assigns value to * - device->priv->profiles (profiles to be added to combobox) @@ -430,7 +429,6 @@ gvc_mixer_ui_device_set_profiles (GvcMixerUIDevice *device, /** * gvc_mixer_ui_device_get_best_profile: - * * @selected: The selected profile or its canonical name or %NULL for any profile * @current: The currently selected profile * @@ -543,6 +541,12 @@ gvc_mixer_ui_device_should_profiles_be_hidden (GvcMixerUIDevice *device) return device->priv->disable_profile_swapping; } +/** + * gvc_mixer_ui_device_get_profiles: + * @device: + * + * Returns: (transfer none) (element-type Gvc.MixerCardProfile): + */ GList* gvc_mixer_ui_device_get_profiles (GvcMixerUIDevice *device) { @@ -551,6 +555,12 @@ gvc_mixer_ui_device_get_profiles (GvcMixerUIDevice *device) return device->priv->profiles; } +/** + * gvc_mixer_ui_device_get_supported_profiles: + * @device: + * + * Returns: (transfer none) (element-type Gvc.MixerCardProfile): + */ GList* gvc_mixer_ui_device_get_supported_profiles (GvcMixerUIDevice *device) { diff --git a/gvc-mixer-ui-device.h b/gvc-mixer-ui-device.h index fbf3b9c..14ae09b 100644 --- a/gvc-mixer-ui-device.h +++ b/gvc-mixer-ui-device.h @@ -53,29 +53,29 @@ typedef enum GType gvc_mixer_ui_device_get_type (void) G_GNUC_CONST; -guint gvc_mixer_ui_device_get_id (GvcMixerUIDevice *dev); -gint gvc_mixer_ui_device_get_stream_id (GvcMixerUIDevice *dev); -const gchar * gvc_mixer_ui_device_get_description (GvcMixerUIDevice *dev); -const gchar * gvc_mixer_ui_device_get_origin (GvcMixerUIDevice *dev); -const gchar * gvc_mixer_ui_device_get_port (GvcMixerUIDevice *dev); -const gchar * gvc_mixer_ui_device_get_best_profile (GvcMixerUIDevice *dev, +guint gvc_mixer_ui_device_get_id (GvcMixerUIDevice *device); +gint gvc_mixer_ui_device_get_stream_id (GvcMixerUIDevice *device); +const gchar * gvc_mixer_ui_device_get_description (GvcMixerUIDevice *device); +const gchar * gvc_mixer_ui_device_get_origin (GvcMixerUIDevice *device); +const gchar * gvc_mixer_ui_device_get_port (GvcMixerUIDevice *device); +const gchar * gvc_mixer_ui_device_get_best_profile (GvcMixerUIDevice *device, const gchar *selected, const gchar *current); const gchar * gvc_mixer_ui_device_get_active_profile (GvcMixerUIDevice* device); -const gchar * gvc_mixer_ui_device_get_matching_profile (GvcMixerUIDevice *dev, +const gchar * gvc_mixer_ui_device_get_matching_profile (GvcMixerUIDevice *device, const gchar *profile); -const gchar * gvc_mixer_ui_device_get_user_preferred_profile (GvcMixerUIDevice *dev); -const gchar * gvc_mixer_ui_device_get_top_priority_profile (GvcMixerUIDevice *dev); -GList * gvc_mixer_ui_device_get_profiles (GvcMixerUIDevice *dev); +const gchar * gvc_mixer_ui_device_get_user_preferred_profile (GvcMixerUIDevice *device); +const gchar * gvc_mixer_ui_device_get_top_priority_profile (GvcMixerUIDevice *device); +GList * gvc_mixer_ui_device_get_profiles (GvcMixerUIDevice *device); GList * gvc_mixer_ui_device_get_supported_profiles (GvcMixerUIDevice *device); gboolean gvc_mixer_ui_device_should_profiles_be_hidden (GvcMixerUIDevice *device); void gvc_mixer_ui_device_set_profiles (GvcMixerUIDevice *device, - const GList *profiles); + const GList *in_profiles); void gvc_mixer_ui_device_set_user_preferred_profile (GvcMixerUIDevice *device, const gchar *profile); -void gvc_mixer_ui_device_invalidate_stream (GvcMixerUIDevice *dev); -gboolean gvc_mixer_ui_device_has_ports (GvcMixerUIDevice *dev); -gboolean gvc_mixer_ui_device_is_output (GvcMixerUIDevice *dev); +void gvc_mixer_ui_device_invalidate_stream (GvcMixerUIDevice *device); +gboolean gvc_mixer_ui_device_has_ports (GvcMixerUIDevice *device); +gboolean gvc_mixer_ui_device_is_output (GvcMixerUIDevice *device); G_END_DECLS