aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2013-10-02 02:11:10 +0200
committerPřemysl Janouch <p.janouch@gmail.com>2013-10-02 02:11:10 +0200
commit190c21eabb82dd7571397048077d2b383f30b17d (patch)
tree023f282ef0d2b1985b47a8a73f63c38e76926a15
parent8d586931e003e79720039c8241d14d4a6bbe944c (diff)
downloadtdv-190c21eabb82dd7571397048077d2b383f30b17d.tar.gz
tdv-190c21eabb82dd7571397048077d2b383f30b17d.tar.xz
tdv-190c21eabb82dd7571397048077d2b383f30b17d.zip
Clarify some behaviour in comments
-rw-r--r--src/stardict.c8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/stardict.c b/src/stardict.c
index c26bb52..e54755d 100644
--- a/src/stardict.c
+++ b/src/stardict.c
@@ -426,7 +426,9 @@ stardict_dict_new (const gchar *filename, GError **error)
return sd;
}
-/** Return information about a loaded dictionary. */
+/** Return information about a loaded dictionary. The returned reference is
+ * only valid for the lifetime of the dictionary object.
+ */
StardictInfo *
stardict_dict_get_info (StardictDict *sd)
{
@@ -633,7 +635,7 @@ cannot_open:
}
/** Load a StarDict dictionary.
- * @param[in] sdi Parsed .ifo data.
+ * @param[in] sdi Parsed .ifo data. The dictionary assumes ownership.
*/
StardictDict *
stardict_dict_new_from_info (StardictInfo *sdi, GError **error)
@@ -746,7 +748,7 @@ stardict_dict_get_synonyms (StardictDict *sd, const gchar *word)
return NULL;
}
-/** Search for a word.
+/** Search for a word. The search is ASCII-case-insensitive.
* @param[in] word The word in utf-8 encoding
* @param[out] success TRUE if found
* @return An iterator object pointing to the word, or where it would be