diff options
author | Peng Wu <alexepico@gmail.com> | 2012-04-28 12:52:59 +0800 |
---|---|---|
committer | Peng Wu <alexepico@gmail.com> | 2012-04-28 12:52:59 +0800 |
commit | f383ccfbdd0bf1b3eca3e094879e9283287ad610 (patch) | |
tree | aec5733a12e7ff77454c8a5575d12985f0148cf0 /src/pinyin.h | |
parent | dd3b3559804d57c143443e1ae15562797508b793 (diff) | |
download | libpinyin-f383ccfbdd0bf1b3eca3e094879e9283287ad610.tar.gz libpinyin-f383ccfbdd0bf1b3eca3e094879e9283287ad610.tar.xz libpinyin-f383ccfbdd0bf1b3eca3e094879e9283287ad610.zip |
add comments
Diffstat (limited to 'src/pinyin.h')
-rw-r--r-- | src/pinyin.h | 20 |
1 files changed, 20 insertions, 0 deletions
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); |