summaryrefslogtreecommitdiffstats
path: root/src/pinyin.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/pinyin.h')
-rw-r--r--src/pinyin.h34
1 files changed, 33 insertions, 1 deletions
diff --git a/src/pinyin.h b/src/pinyin.h
index c691197..863e945 100644
--- a/src/pinyin.h
+++ b/src/pinyin.h
@@ -952,17 +952,49 @@ bool pinyin_get_phrase_token(pinyin_instance_t * instance,
guint index,
phrase_token_t * token);
-
+/**
+ * pinyin_get_full_pinyin_auxiliary_text:
+ * @instance: the pinyin instance.
+ * @input: the user input.
+ * @cursor: the current cursor.
+ * @aux_text: the auxiliary text.
+ * @returns: whether the get operation is successful.
+ *
+ * Get the auxiliary text for full pinyin.
+ *
+ */
bool pinyin_get_full_pinyin_auxiliary_text(pinyin_instance_t * instance,
const char * input,
size_t cursor,
gchar ** aux_text);
+/**
+ * pinyin_get_double_pinyin_auxiliary_text:
+ * @instance: the pinyin instance.
+ * @input: the user input.
+ * @cursor: the current cursor.
+ * @aux_text: the auxiliary text.
+ * @returns: whether the get operation is successful.
+ *
+ * Get the auxiliary text for double pinyin.
+ *
+ */
bool pinyin_get_double_pinyin_auxiliary_text(pinyin_instance_t * instance,
const char * input,
size_t cursor,
gchar ** aux_text);
+/**
+ * pinyin_get_chewing_auxiliary_text:
+ * @instance: the pinyin instance.
+ * @input: the user input.
+ * @cursor: the current cursor.
+ * @aux_text: the auxiliary text.
+ * @returns: whether the get operation is successful.
+ *
+ * Get the auxiliary text for chewing.
+ *
+ */
bool pinyin_get_chewing_auxiliary_text(pinyin_instance_t * instance,
const char * input,
size_t cursor,