diff options
author | Peng Wu <alexepico@gmail.com> | 2012-12-04 10:10:02 +0800 |
---|---|---|
committer | Peng Wu <alexepico@gmail.com> | 2012-12-04 10:10:02 +0800 |
commit | 01b200662b3706c071658103c1cc73ea307d685f (patch) | |
tree | 6ddc54726ec0363334b81484a566e881ef32d992 | |
parent | 3d1f1928a5d3317e90767a094466f3b2a0604254 (diff) | |
download | libpinyin-01b200662b3706c071658103c1cc73ea307d685f.tar.gz libpinyin-01b200662b3706c071658103c1cc73ea307d685f.tar.xz libpinyin-01b200662b3706c071658103c1cc73ea307d685f.zip |
add comments
-rw-r--r-- | src/pinyin.h | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/src/pinyin.h b/src/pinyin.h index fd4e43a..03f391f 100644 --- a/src/pinyin.h +++ b/src/pinyin.h @@ -513,11 +513,30 @@ bool pinyin_train(pinyin_instance_t * instance); */ bool pinyin_reset(pinyin_instance_t * instance); - +/** + * pinyin_get_chewing_string: + * @instance: the pinyin instance. + * @key: the chewing key. + * @utf8_str: the chewing string. + * @returns: whether the get operation is successful. + * + * Get the chewing string of the key. + * + */ bool pinyin_get_chewing_string(pinyin_instance_t * instance, ChewingKey * key, gchar ** utf8_str); +/** + * pinyin_get_pinyin_string: + * @instance: the pinyin instance. + * @key: the pinyin key. + * @utf8_str: the pinyin string. + * @returns: whether the get operation is successful. + * + * Get the pinyin string of the key. + * + */ bool pinyin_get_pinyin_string(pinyin_instance_t * instance, ChewingKey * key, gchar ** utf8_str); |