From f383ccfbdd0bf1b3eca3e094879e9283287ad610 Mon Sep 17 00:00:00 2001 From: Peng Wu Date: Sat, 28 Apr 2012 12:52:59 +0800 Subject: add comments --- src/pinyin.h | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/pinyin.h b/src/pinyin.h index 3ac3aa0..58ed1cb 100644 --- a/src/pinyin.h +++ b/src/pinyin.h @@ -309,6 +309,16 @@ bool pinyin_get_candidates(pinyin_instance_t * instance, size_t offset, TokenVector candidates); +/** + * pinyin_get_full_pinyin_candidates: + * @instance: the pinyin instance. + * @offset: the offset in the pinyin keys. + * @candidates: the GArray of lookup_candidate_t candidates. + * @returns: whether a list of lookup_candidate_t candidates are gotten. + * + * Get the full pinyin candidates at the offset. + * + */ bool pinyin_get_full_pinyin_candidates(pinyin_instance_t * instance, size_t offset, CandidateVector candidates); @@ -327,6 +337,16 @@ int pinyin_choose_candidate(pinyin_instance_t * instance, size_t offset, phrase_token_t token); +/** + * pinyin_choose_full_pinyin_candidate: + * @instance: the pinyin instance. + * @offset: the offset in the pinyin keys. + * @candidate: the selected lookup_candidate_t candidate. + * @returns: the cursor after the chosen candidate. + * + * Choose a full pinyin candidate at the offset. + * + */ int pinyin_choose_full_pinyin_candidate(pinyin_instance_t * instance, size_t offset, lookup_candidate_t * candidate); -- cgit