diff options
author | Peng Wu <alexepico@gmail.com> | 2015-01-22 15:12:19 +0800 |
---|---|---|
committer | Peng Wu <alexepico@gmail.com> | 2015-01-22 15:13:33 +0800 |
commit | e60fddffd519f10f70e49aae5ba431bc9badad33 (patch) | |
tree | f794a38723f1cd66250de828b2b4909d56b4032a | |
parent | 71f0161885f333ee13d81215b201bef9fd28c928 (diff) | |
download | libpinyin-e60fddffd519f10f70e49aae5ba431bc9badad33.tar.gz libpinyin-e60fddffd519f10f70e49aae5ba431bc9badad33.tar.xz libpinyin-e60fddffd519f10f70e49aae5ba431bc9badad33.zip |
add comments
-rw-r--r-- | src/libpinyin.ver | 4 | ||||
-rw-r--r-- | src/pinyin.h | 35 |
2 files changed, 39 insertions, 0 deletions
diff --git a/src/libpinyin.ver b/src/libpinyin.ver index 64879d7..a7b5073 100644 --- a/src/libpinyin.ver +++ b/src/libpinyin.ver @@ -9,6 +9,10 @@ LIBPINYIN { pinyin_begin_add_phrases; pinyin_iterator_add_phrase; pinyin_end_add_phrases; + pinyin_begin_get_phrases; + pinyin_iterator_has_next_phrase; + pinyin_iterator_get_next_phrase; + pinyin_end_get_phrases; pinyin_fini; pinyin_mask_out; pinyin_set_options; diff --git a/src/pinyin.h b/src/pinyin.h index c0ec076..ebee9a2 100644 --- a/src/pinyin.h +++ b/src/pinyin.h @@ -121,16 +121,51 @@ bool pinyin_iterator_add_phrase(import_iterator_t * iter, */ void pinyin_end_add_phrases(import_iterator_t * iter); +/** + * pinyin_begin_get_phrases: + * @context: the pinyin context. + * @index: the phrase index to be exported. + * @returns: the export iterator. + * + * Begin to get phrases. + * + */ export_iterator_t * pinyin_begin_get_phrases(pinyin_context_t * context, guint index); +/** + * pinyin_iterator_has_next_phrase: + * @iter: the export iterator. + * @returns: whether the iterator has the next phrase. + * + * Check whether the iterator has the next phrase. + * + */ bool pinyin_iterator_has_next_phrase(export_iterator_t * iter); +/** + * pinyin_iterator_get_next_phrase: + * @iter: the export iterator. + * @phrase: the phrase string. + * @pinyin: the pinyin string. + * @count: the count of the phrase/pinyin pair, -1 means the default value. + * @returns: whether the get next phrase operation succeeded. + * + * Get a pair of phrase and pinyin with count. + * + */ bool pinyin_iterator_get_next_phrase(export_iterator_t * iter, gchar ** phrase, gchar ** pinyin, gint * count); +/** + * pinyin_end_get_phrases: + * @iter: the export iterator. + * + * End getting phrases. + * + */ void pinyin_end_get_phrases(export_iterator_t * iter); /** |