add comments

1 files changed, 19 insertions, 0 deletions

diff --git a/src/pinyin.h b/src/pinyin.h
index 43cec3e..53c557c 100644
--- a/src/pinyin.h
+++ b/src/pinyin.h
@@ -81,10 +81,29 @@ struct _pinyin_instance_t{
  */
 pinyin_context_t * pinyin_init(const char * systemdir, const char * userdir);
 
+/**
+ * pinyin_load_phrase_library:
+ * @context: the pinyin context.
+ * @index: the phrase index to be loaded.
+ * @filename: the file name of the phrase index.
+ * @returns: whether the load succeeded.
+ *
+ * Load the sub phrase library of the index.
+ *
+ */
 bool pinyin_load_phrase_library(pinyin_context_t * context,
                                 guint8 index,
                                 const char * filename);
 
+/**
+ * pinyin_unload_phrase_library:
+ * @context: the pinyin context.
+ * @index: the phrase index to be unloaded.
+ * @returns: whether the unload succeeded.
+ *
+ * Unload the sub phrase library of the index.
+ *
+ */
 bool pinyin_unload_phrase_library(pinyin_context_t * context,
                                   guint8 index);