add comments

diff --git a/src/pinyin.h b/src/pinyin.h
index 43cec3e..53c557c 100644 (file)
--- 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);
 

diff --git a/src/storage/phrase_index.h b/src/storage/phrase_index.h
index 94c8820..f1e460c 100644 (file)
--- a/src/storage/phrase_index.h
+++ b/src/storage/phrase_index.h
@@ -708,6 +708,14 @@ public:
         return true;
     }
 
+    /**
+     * FacadePhraseIndex::create_sub_phrase:
+     * @index: the phrase index to be created.
+     * @returns: the result of the create operation.
+     *
+     * Create the sub phrase index.
+     *
+     */
     int create_sub_phrase(guint8 index) {
        SubPhraseIndex * & sub_phrase = m_sub_phrase_indices[index];
        if (sub_phrase) {