summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDom Lachowicz <domlachowicz@gmail.com>2010-01-11 12:39:54 +0000
committerDom Lachowicz <domlachowicz@gmail.com>2010-01-11 12:39:54 +0000
commit87af64438238ce5931cf0afad271f49320e37192 (patch)
tree3b9660ac23b50df81f6066bf1573f62e025f1b64
parent34e7ea86dbc3b62bb8019fd69b23202fc1a5118e (diff)
downloadenchant-87af64438238ce5931cf0afad271f49320e37192.tar.gz
Bug 12556 - document that dictionary-related functions return a reference-counted object
git-svn-id: svn+ssh://svn.abisource.com/svnroot/enchant/trunk@28599 bcba8976-2d24-0410-9c9c-aab3bd5fdfd6
-rw-r--r--src/enchant.c4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/enchant.c b/src/enchant.c
index 6fd1ebb..0446f1a 100644
--- a/src/enchant.c
+++ b/src/enchant.c
@@ -1737,7 +1737,7 @@ enchant_broker_free (EnchantBroker * broker)
* @pwl: A non-null pathname in the GLib file name encoding (UTF-8 on Windows)
* to the personal wordlist file
*
- * Returns:
+ * Returns: An EnchantDict. This dictionary is reference counted.
*/
ENCHANT_MODULE_EXPORT (EnchantDict *)
enchant_broker_request_pwl_dict (EnchantBroker * broker, const char *const pwl)
@@ -1832,7 +1832,7 @@ _enchant_broker_request_dict (EnchantBroker * broker, const char *const tag)
* @broker: A non-null #EnchantBroker
* @tag: The non-null language tag you wish to request a dictionary for ("en_US", "de_DE", ...)
*
- * Returns: An #EnchantDict, or %null if no suitable dictionary could be found.
+ * Returns: An #EnchantDict, or %null if no suitable dictionary could be found. This dictionary is reference counted.
*/
ENCHANT_MODULE_EXPORT (EnchantDict *)
enchant_broker_request_dict (EnchantBroker * broker, const char *const tag)