diff options
author | Sergey Udaltsov <svu@gnome.org> | 2011-02-12 22:38:56 +0000 |
---|---|---|
committer | Sergey Udaltsov <svu@gnome.org> | 2011-02-12 22:38:56 +0000 |
commit | 2fc480d3d9e7c986d37fc367e569437a2fb424ca (patch) | |
tree | b5f2b4a94e540b5321e60ecedcd8ade9d04da7fa | |
parent | a0ed67a8480728ab56fd440c782869dded25bfaa (diff) | |
download | libxklavier-2fc480d3d9e7c986d37fc367e569437a2fb424ca.tar.gz |
some more gtk-doc comments
-rw-r--r-- | libxklavier/xkl_config_item.h | 16 | ||||
-rw-r--r-- | libxklavier/xkl_config_registry.h | 6 |
2 files changed, 19 insertions, 3 deletions
diff --git a/libxklavier/xkl_config_item.h b/libxklavier/xkl_config_item.h index ef2624c..0095c70 100644 --- a/libxklavier/xkl_config_item.h +++ b/libxklavier/xkl_config_item.h @@ -132,8 +132,24 @@ extern "C" { */ extern XklConfigItem *xkl_config_item_new(void); +/** + * xkl_get_country_name: + * @code: ISO 3166 Alpha 2 code: 2 chars, uppercase (US, RU, FR, ...) + * + * Get localized country name, from ISO code + * + * Returns: localized country name (USA, Russia, France, ... translated) + */ extern const gchar * xkl_get_country_name(const gchar * code); +/** + * xkl_get_language_name: + * @code: ISO 639 2B or 2T code: 3 chars, lowercase (eng, rus, fra, ...) + * + * Get localized language name, from ISO code + * + * Returns: localized country name (English, Russiam, French, ... translated) + */ extern const gchar * xkl_get_language_name(const gchar * code); #ifdef __cplusplus diff --git a/libxklavier/xkl_config_registry.h b/libxklavier/xkl_config_registry.h index f798377..d3e04f6 100644 --- a/libxklavier/xkl_config_registry.h +++ b/libxklavier/xkl_config_registry.h @@ -358,15 +358,15 @@ extern "C" { /** * xkl_config_registry_search_by_pattern: * @config: the config registry - * @pattern: pattern to search for + * @pattern: pattern to search for (NULL means "all") * @func: 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. * The layout/variant is considered as matching if one of the following * is true: - * 1. Country description (from the country list) contains pattern as substring - * 2. Language description (from the language list) contains pattern as substring + * 1. Country description (from the country list or name) contains pattern as substring + * 2. Language description (from the language list or name) contains pattern as substring */ extern void xkl_config_registry_search_by_pattern(XklConfigRegistry * config, |