p
/
tdv
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clarify some behaviour in comments

This commit is contained in:
Přemysl Eric Janouch 2013-10-02 02:11:10 +02:00
parent 8d586931e0
commit 190c21eabb
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/stardict.c
View File

@ -426,7 +426,9 @@ stardict_dict_new (const gchar *filename, GError **error)
return sd; 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 * StardictInfo *
stardict_dict_get_info (StardictDict *sd) stardict_dict_get_info (StardictDict *sd)
{ {
@ -633,7 +635,7 @@ cannot_open:
} }
/** Load a StarDict dictionary. /** Load a StarDict dictionary.
* @param[in] sdi Parsed .ifo data. * @param[in] sdi Parsed .ifo data. The dictionary assumes ownership.
*/ */
StardictDict * StardictDict *
stardict_dict_new_from_info (StardictInfo *sdi, GError **error) stardict_dict_new_from_info (StardictInfo *sdi, GError **error)
@ -746,7 +748,7 @@ stardict_dict_get_synonyms (StardictDict *sd, const gchar *word)
return NULL; 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[in] word The word in utf-8 encoding
* @param[out] success TRUE if found * @param[out] success TRUE if found
* @return An iterator object pointing to the word, or where it would be * @return An iterator object pointing to the word, or where it would be