From 54c7e9530251d912266587ed192892e37e37c262 Mon Sep 17 00:00:00 2001 From: Stef Walter Date: Wed, 9 May 2012 10:56:40 +0200 Subject: Fix gobject-introspection comments * Cleans up a bunch of warnings, and gets g-ir-scanner to actually recognize the annotations. https://bugzilla.gnome.org/show_bug.cgi?id=675729 --- libgnomekbd/gkbd-configuration.c | 21 +++++++++++++++------ libgnomekbd/gkbd-desktop-config.c | 6 +++--- libgnomekbd/gkbd-desktop-config.h | 2 +- libgnomekbd/gkbd-indicator-config.c | 4 ++-- libgnomekbd/gkbd-indicator-config.h | 2 +- libgnomekbd/gkbd-indicator.c | 2 ++ libgnomekbd/gkbd-keyboard-config.c | 11 ++++++----- libgnomekbd/gkbd-keyboard-config.h | 2 +- libgnomekbd/gkbd-keyboard-drawing.c | 9 ++++++--- libgnomekbd/gkbd-status.c | 2 ++ libgnomekbd/gkbd-util.c | 2 ++ 11 files changed, 41 insertions(+), 22 deletions(-) (limited to 'libgnomekbd') diff --git a/libgnomekbd/gkbd-configuration.c b/libgnomekbd/gkbd-configuration.c index ea58ec3..546c462 100644 --- a/libgnomekbd/gkbd-configuration.c +++ b/libgnomekbd/gkbd-configuration.c @@ -342,7 +342,8 @@ gkbd_configuration_class_init (GkbdConfigurationClass * klass) } /** - * gkbd_configuration_get: + * gkbd_configuration_get: + * * Returns: (transfer full): singleton of GkbdConfiguration */ GkbdConfiguration * @@ -362,6 +363,7 @@ gkbd_configuration_get (void) /** * gkbd_configuration_get_xkl_engine: + * * Returns: (transfer none): The engine used by GkbdConfiguration object */ XklEngine * @@ -372,6 +374,7 @@ gkbd_configuration_get_xkl_engine (GkbdConfiguration * configuration) /** * gkbd_configuration_get_group_names: + * * Returns: (transfer none) (array zero-terminated=1): full group names */ gchar ** @@ -392,6 +395,7 @@ gkbd_configuration_get_image_filename (GkbdConfiguration * configuration, /** * gkbd_configuration_get_short_group_names: + * * Returns: (transfer none) (array zero-terminated=1): short group names */ gchar ** @@ -491,7 +495,8 @@ gkbd_configuration_get_current_group (GkbdConfiguration * configuration) } /** - * gkbd_configuration_get_indicator_config: + * gkbd_configuration_get_indicator_config: + * * Returns: (transfer none): indicator config */ GkbdIndicatorConfig * @@ -501,7 +506,8 @@ gkbd_configuration_get_indicator_config (GkbdConfiguration * configuration) } /** - * gkbd_configuration_get_keyboard_config: + * gkbd_configuration_get_keyboard_config: + * * Returns: (transfer none): keyboard config */ GkbdKeyboardConfig * @@ -511,7 +517,8 @@ gkbd_configuration_get_keyboard_config (GkbdConfiguration * configuration) } /** - * gkbd_configuration_get_all_objects: + * gkbd_configuration_get_all_objects: + * * Returns: (transfer none) (element-type GObject): list of widgets/status icons/... */ GSList * @@ -537,7 +544,8 @@ gkbd_configuration_remove_object (GkbdConfiguration * configuration, } /** - * gkbd_configuration_load_images: + * gkbd_configuration_load_images: + * * Returns: (transfer full) (element-type GdkPixbuf): list of images */ GSList * @@ -574,7 +582,7 @@ gkbd_configuration_load_images (GkbdConfiguration * configuration) } /** - * gkbd_configuration_free_images: + * gkbd_configuration_free_images: * @images: (element-type GdkPixbuf): list of images */ void @@ -676,6 +684,7 @@ gkbd_configuration_stop_listen (GkbdConfiguration * configuration) /** * gkbd_configuration_get_group_name: + * * Returns: (transfer full): group name */ gchar * diff --git a/libgnomekbd/gkbd-desktop-config.c b/libgnomekbd/gkbd-desktop-config.c index 814338c..940611b 100644 --- a/libgnomekbd/gkbd-desktop-config.c +++ b/libgnomekbd/gkbd-desktop-config.c @@ -30,7 +30,7 @@ #include /** - * GkbdDesktopConfig + * GkbdDesktopConfig: */ const gchar GKBD_DESKTOP_CONFIG_KEY_DEFAULT_GROUP[] = "default-group"; const gchar GKBD_DESKTOP_CONFIG_KEY_GROUP_PER_WINDOW[] = @@ -42,7 +42,7 @@ const gchar GKBD_DESKTOP_CONFIG_KEY_LAYOUT_NAMES_AS_GROUP_NAMES[] const gchar GKBD_DESKTOP_CONFIG_KEY_LOAD_EXTRA_ITEMS[] = "load-extra-items"; -/** +/* * static common functions */ @@ -125,7 +125,7 @@ static gboolean return TRUE; } -/** +/* * extern GkbdDesktopConfig config functions */ void diff --git a/libgnomekbd/gkbd-desktop-config.h b/libgnomekbd/gkbd-desktop-config.h index b9213c2..9c737ab 100644 --- a/libgnomekbd/gkbd-desktop-config.h +++ b/libgnomekbd/gkbd-desktop-config.h @@ -49,7 +49,7 @@ struct _GkbdDesktopConfig { XklEngine *engine; }; -/** +/* * GkbdDesktopConfig functions */ extern void gkbd_desktop_config_init (GkbdDesktopConfig * config, diff --git a/libgnomekbd/gkbd-indicator-config.c b/libgnomekbd/gkbd-indicator-config.c index 4545a4f..80de663 100644 --- a/libgnomekbd/gkbd-indicator-config.c +++ b/libgnomekbd/gkbd-indicator-config.c @@ -35,7 +35,7 @@ #include /** - * GkbdIndicatorConfig + * GkbdIndicatorConfig: */ const gchar GKBD_INDICATOR_CONFIG_KEY_SHOW_FLAGS[] = "show-flags"; @@ -47,7 +47,7 @@ const gchar GKBD_INDICATOR_CONFIG_KEY_FOREGROUND_COLOR[] = const gchar GKBD_INDICATOR_CONFIG_KEY_BACKGROUND_COLOR[] = "background-color"; -/** +/* * static applet config functions */ diff --git a/libgnomekbd/gkbd-indicator-config.h b/libgnomekbd/gkbd-indicator-config.h index 3c1515b..5e9cab2 100644 --- a/libgnomekbd/gkbd-indicator-config.h +++ b/libgnomekbd/gkbd-indicator-config.h @@ -45,7 +45,7 @@ struct _GkbdIndicatorConfig { XklEngine *engine; }; -/** +/* * GkbdIndicatorConfig functions - * some of them require GkbdKeyboardConfig as well - * for loading approptiate images diff --git a/libgnomekbd/gkbd-indicator.c b/libgnomekbd/gkbd-indicator.c index 413284b..a3afdf3 100644 --- a/libgnomekbd/gkbd-indicator.c +++ b/libgnomekbd/gkbd-indicator.c @@ -531,6 +531,7 @@ gkbd_indicator_set_parent_tooltips (GkbdIndicator * gki, gboolean spt) /** * gkbd_indicator_get_xkl_engine: + * * Returns: (transfer none): The engine shared by all GkbdIndicator objects */ XklEngine * @@ -541,6 +542,7 @@ gkbd_indicator_get_xkl_engine () /** * gkbd_indicator_get_group_names: + * * Returns: (transfer none) (array zero-terminated=1): List of group names */ gchar ** diff --git a/libgnomekbd/gkbd-keyboard-config.c b/libgnomekbd/gkbd-keyboard-config.c index e4e035e..8daf578 100644 --- a/libgnomekbd/gkbd-keyboard-config.c +++ b/libgnomekbd/gkbd-keyboard-config.c @@ -30,7 +30,7 @@ #include #include -/** +/* * GkbdKeyboardConfig */ @@ -47,7 +47,7 @@ const gchar *GKBD_KEYBOARD_CONFIG_ACTIVE[] = { GKBD_KEYBOARD_CONFIG_KEY_OPTIONS }; -/** +/* * static common functions */ @@ -123,7 +123,7 @@ gkbd_keyboard_config_get_lv_descriptions (XklConfigRegistry * return *layout_descr != NULL; } -/** +/* * extern common functions */ const gchar * @@ -177,7 +177,7 @@ gkbd_keyboard_config_split_items (const gchar * merged, gchar ** parent, return TRUE; } -/** +/* * static GkbdKeyboardConfig functions */ @@ -404,7 +404,7 @@ gkbd_keyboard_config_save_params (GkbdKeyboardConfig * kbd_config, } } -/** +/* * extern GkbdKeyboardConfig config functions */ void @@ -747,6 +747,7 @@ gkbd_keyboard_config_to_string (const GkbdKeyboardConfig * config) /** * gkbd_keyboard_config_add_default_switch_option_if_necessary: + * * Returns: (transfer full) (array zero-terminated=1): List of options */ gchar ** diff --git a/libgnomekbd/gkbd-keyboard-config.h b/libgnomekbd/gkbd-keyboard-config.h index 99ecac6..5bc1c2f 100644 --- a/libgnomekbd/gkbd-keyboard-config.h +++ b/libgnomekbd/gkbd-keyboard-config.h @@ -46,7 +46,7 @@ struct _GkbdKeyboardConfig { XklEngine *engine; }; -/** +/* * GkbdKeyboardConfig functions */ extern void gkbd_keyboard_config_init (GkbdKeyboardConfig * kbd_config, diff --git a/libgnomekbd/gkbd-keyboard-drawing.c b/libgnomekbd/gkbd-keyboard-drawing.c index e8ad533..899df18 100644 --- a/libgnomekbd/gkbd-keyboard-drawing.c +++ b/libgnomekbd/gkbd-keyboard-drawing.c @@ -1063,8 +1063,8 @@ draw_key_label (GkbdKeyboardDrawingRenderContext * context, } } -/** - The x offset is calculated for complex shapes. It is the rightmost of the vertical lines in the outline +/* + * The x offset is calculated for complex shapes. It is the rightmost of the vertical lines in the outline */ static gint calc_shape_origin_offset_x (XkbOutlineRec * outline) @@ -2252,7 +2252,7 @@ gkbd_keyboard_drawing_set_mods (GkbdKeyboardDrawing * drawing, guint mods) * from e.g. a GtkWidget or a GtkPrintContext. @cr and @layout may be modified * by the function but will not be unreffed. * - * @returns: %TRUE on success, %FALSE on failure + * Returns: %TRUE on success, %FALSE on failure */ gboolean gkbd_keyboard_drawing_render (GkbdKeyboardDrawing * kbdrawing, @@ -2291,6 +2291,9 @@ gkbd_keyboard_drawing_render (GkbdKeyboardDrawing * kbdrawing, return TRUE; } +/** + * gkbd_keyboard_drawing_set_keyboard: (skip) + */ gboolean gkbd_keyboard_drawing_set_keyboard (GkbdKeyboardDrawing * drawing, XkbComponentNamesRec * names) diff --git a/libgnomekbd/gkbd-status.c b/libgnomekbd/gkbd-status.c index 72ff5e4..8778250 100644 --- a/libgnomekbd/gkbd-status.c +++ b/libgnomekbd/gkbd-status.c @@ -664,6 +664,7 @@ gkbd_status_new (void) /** * gkbd_status_get_xkl_engine: + * * Returns: (transfer none): The engine shared by all GkbdStatus objects */ XklEngine * @@ -674,6 +675,7 @@ gkbd_status_get_xkl_engine () /** * gkbd_status_get_group_names: + * * Returns: (transfer none) (array zero-terminated=1): List of group names */ gchar ** diff --git a/libgnomekbd/gkbd-util.c b/libgnomekbd/gkbd-util.c index abd093e..e7fd10c 100644 --- a/libgnomekbd/gkbd-util.c +++ b/libgnomekbd/gkbd-util.c @@ -52,6 +52,7 @@ const gchar GKBD_PREVIEW_CONFIG_KEY_HEIGHT[] = "height"; /** * gkbd_preview_load_position: + * * Returns: (transfer full): A rectangle to use */ GdkRectangle * @@ -132,6 +133,7 @@ gkbd_strv_remove (gchar ** arr, const gchar * element) /** * gkbd_strv_append: + * * Returns: (transfer full) (array zero-terminated=1): Append string to strv array */ gchar ** -- cgit v1.2.1