From db23c18befb7e79f3f40e50dc3153e048df437d3 Mon Sep 17 00:00:00 2001 From: Martin Pitt Date: Sun, 8 Jan 2012 13:23:59 +0100 Subject: [PATCH 2/6] Add GI annotations Add missing transfer, scope, and struct member annotations. --- libxklavier/xkl_config_rec.h | 6 ++++++ libxklavier/xkl_config_registry.h | 22 +++++++++++----------- libxklavier/xkl_engine.h | 10 +++++----- 3 files changed, 22 insertions(+), 16 deletions(-) diff --git a/libxklavier/xkl_config_rec.h b/libxklavier/xkl_config_rec.h index 707025f..0658d04 100644 --- a/libxklavier/xkl_config_rec.h +++ b/libxklavier/xkl_config_rec.h @@ -27,6 +27,12 @@ extern "C" { #endif /* __cplusplus */ + /** + * XklConfigRec: + * @layouts: (array zero-terminated=1): + * @variants: (array zero-terminated=1): + * @options: (array zero-terminated=1): + */ typedef struct _XklConfigRec XklConfigRec; typedef struct _XklConfigRecClass XklConfigRecClass; diff --git a/libxklavier/xkl_config_registry.h b/libxklavier/xkl_config_registry.h index d3e04f6..d9b3db4 100644 --- a/libxklavier/xkl_config_registry.h +++ b/libxklavier/xkl_config_registry.h @@ -79,7 +79,7 @@ extern "C" { * * Create new XklConfig * - * Returns: new instance + * Returns: (transfer none): new instance */ extern XklConfigRegistry * xkl_config_registry_get_instance(XklEngine * engine); @@ -131,7 +131,7 @@ extern "C" { /** * xkl_config_registry_foreach_model: * @config: the config registry - * @func: callback to call for every model + * @func: (scope call): callback to call for every model * @data: anything which can be stored into the pointer * * Enumerates keyboard models from the XML configuration registry @@ -144,7 +144,7 @@ extern "C" { /** * xkl_config_registry_foreach_layout: * @config: the config registry - * @func: callback to call for every layout + * @func: (scope call): callback to call for every layout * @data: anything which can be stored into the pointer * * Enumerates keyboard layouts from the XML configuration registry @@ -159,7 +159,7 @@ extern "C" { * xkl_config_registry_foreach_layout_variant: * @config: the config registry * @layout_name: layout name for which variants will be listed - * @func: callback to call for every layout variant + * @func: (scope call): callback to call for every layout variant * @data: anything which can be stored into the pointer * * Enumerates keyboard layout variants from the XML configuration registry @@ -175,7 +175,7 @@ extern "C" { /** * xkl_config_registry_foreach_option_group: * @config: the config registry - * @func: callback to call for every option group + * @func: (scope call): callback to call for every option group * @data: anything which can be stored into the pointer * * Enumerates keyboard option groups from the XML configuration registry @@ -191,7 +191,7 @@ extern "C" { * @config: the config registry * @option_group_name: option group name for which variants * will be listed - * @func: callback to call for every option + * @func: (scope call): callback to call for every option * @data: anything which can be stored into the pointer * * Enumerates keyboard options from the XML configuration registry @@ -291,7 +291,7 @@ extern "C" { /** * xkl_config_registry_foreach_country: * @config: the config registry - * @func: callback to call for every ISO 3166 country code + * @func: (scope call): callback to call for every ISO 3166 country code * @data: anything which can be stored into the pointer * * Enumerates countries for which layouts are available, @@ -307,7 +307,7 @@ extern "C" { * xkl_config_registry_foreach_country_variant: * @config: the config registry * @country_code: country ISO code for which variants will be listed - * @func: callback to call for every country variant + * @func: (scope call): callback to call for every country variant * @data: anything which can be stored into the pointer * * Enumerates keyboard layout variants for the country, @@ -324,7 +324,7 @@ extern "C" { /** * xkl_config_registry_foreach_language: * @config: the config registry - * @func: callback to call for every ISO 639-2 country code + * @func: (scope call): callback to call for every ISO 639-2 country code * @data: anything which can be stored into the pointer * * Enumerates languages for which layouts are available, @@ -340,7 +340,7 @@ extern "C" { * xkl_config_registry_foreach_language_variant: * @config: the config registry * @language_code: language ISO code for which variants will be listed - * @func: callback to call for every country variant + * @func: (scope call): callback to call for every country variant * @data: anything which can be stored into the pointer * * Enumerates keyboard layout variants for the language, @@ -359,7 +359,7 @@ extern "C" { * xkl_config_registry_search_by_pattern: * @config: the config registry * @pattern: pattern to search for (NULL means "all") - * @func: callback to call for every matching layout/variant + * @func: (scope call): callback to call for every matching layout/variant * @data: anything which can be stored into the pointer * * Enumerates keyboard layout/variants that match the pattern. diff --git a/libxklavier/xkl_engine.h b/libxklavier/xkl_engine.h index b92e741..101350c 100644 --- a/libxklavier/xkl_engine.h +++ b/libxklavier/xkl_engine.h @@ -167,7 +167,7 @@ extern "C" { * * Get the instance of the XklEngine. Within a process, there is always once instance. * - * Returns: the singleton instance + * Returns: (transfer none): the singleton instance */ extern XklEngine *xkl_engine_get_instance(Display * display); @@ -433,8 +433,8 @@ extern "C" { * xkl_engine_get_groups_names: * @engine: the engine * - * Returns: the array of group names for the current XKB configuration - * (keyboard). + * Returns: (transfer none): the array of group names for the current XKB + * configuration (keyboard). * This array is static, should not be freed */ extern const gchar **xkl_engine_get_groups_names(XklEngine * @@ -444,8 +444,8 @@ extern "C" { * xkl_engine_get_indicators_names: * @engine: the engine * - * Returns: the array of indicator names for the current XKB configuration - * (keyboard). + * Returns: (transfer none): the array of indicator names for the current XKB + * configuration (keyboard). * This array is static, should not be freed */ extern const gchar **xkl_engine_get_indicators_names(XklEngine * -- 1.7.7.3