[tracker/harmattan: 1901/2240] libtracker-common: Improve TrackerLanguage documentation
- From: Martyn James Russell <mr src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [tracker/harmattan: 1901/2240] libtracker-common: Improve TrackerLanguage documentation
- Date: Thu, 4 Feb 2010 17:22:00 +0000 (UTC)
commit 5a742039903da4cbe08880bd8b182eec70bed077
Author: Martyn Russell <martyn lanedo com>
Date: Mon Dec 21 11:15:24 2009 +0000
libtracker-common: Improve TrackerLanguage documentation
src/libtracker-common/tracker-language.c | 28 +++++++++++++++++++++-------
1 files changed, 21 insertions(+), 7 deletions(-)
---
diff --git a/src/libtracker-common/tracker-language.c b/src/libtracker-common/tracker-language.c
index 56dd418..dfd9b1b 100644
--- a/src/libtracker-common/tracker-language.c
+++ b/src/libtracker-common/tracker-language.c
@@ -420,10 +420,10 @@ tracker_language_set_enable_stemmer (TrackerLanguage *language,
/**
* tracker_language_set_language_code:
* @language: a #TrackerLanguage
- * @value: a ISO 639-1 language code, or %NULL to reset to english
+ * @value: an ISO 639-1 language code
*
- * Sets the language handled by @language, a %NULL value will reset
- * to "en"
+ * Sets the @language to @value, a %NULL value will reset this to
+ * "en" (English).
**/
void
tracker_language_set_language_code (TrackerLanguage *language,
@@ -611,12 +611,26 @@ tracker_language_get_name_by_code (const gchar *language_code)
/**
* tracker_language_get_code_by_name:
- * @language_name: language name
+ * @language_name: a string representing the language name
*
- * Returns the ISO 639-1 code corresponding to the language name,
- * if supported by #TrackerLanguage.
+ * Supported @language_name strings and their ISO 639-1 codes include:
*
- * Returns: the ISO 639-1 code.
+ * - "Danish" (da)
+ * - "Dutch" (nl)
+ * - "English" (en)
+ * - "Finnish" (fi)
+ * - "French" (fr)
+ * - "German" (de)
+ * - "Hungarian" (hu)
+ * - "Italian" (it)
+ * - "Norwegian" (nb)
+ * - "Portuguese" (pt)
+ * - "Russian" (ru)
+ * - "Spanish" (es)
+ * - "Swedish" (sv)
+ *
+ * Returns: the ISO 639-1 code corresponding to the @language_name,
+ * if it is supported.
**/
const gchar *
tracker_language_get_code_by_name (const gchar *language_name)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]