summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Pitt <martin.pitt@ubuntu.com>2012-01-08 13:23:59 +0100
committerSergey V. Udaltsov <svu@gnome.org>2012-01-10 23:15:12 +0000
commite8a5cd198eb61f36c196e75d1da599e6b11c0b87 (patch)
tree8a3206a4b512d770d244e7aa09d9e9088e0fb14b
parent0a270af05c174668a4ca71bdc666bcf7338f979a (diff)
downloadlibxklavier-e8a5cd198eb61f36c196e75d1da599e6b11c0b87.tar.gz
Add GI annotations
Add missing transfer, scope, and struct member annotations.
-rw-r--r--libxklavier/xkl_config_rec.h6
-rw-r--r--libxklavier/xkl_config_registry.h22
-rw-r--r--libxklavier/xkl_engine.h10
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 *