Update inline API document.

diff --git a/src/ibusattribute.h b/src/ibusattribute.h
index ac40b6df85ee5bbc13760d3c0a3999f691bdf519..28cfbac1c2722dec4621ebd4b3df2e5318f49155 100644 (file)
--- a/src/ibusattribute.h
+++ b/src/ibusattribute.h
@@ -263,7 +263,7 @@ IBusAttrList        *ibus_attr_list_new         ();
  * @attr_list: An IBusAttrList instance.
  * @attr: The IBusAttribute instance to be appended.
  *
- * Append an IBusAttribute to IBusAttrList.
+ * Append an IBusAttribute to IBusAttrList, and increase reference.
  */
 void                 ibus_attr_list_append      (IBusAttrList   *attr_list,
                                                  IBusAttribute  *attr);
@@ -273,7 +273,7 @@ void                 ibus_attr_list_append      (IBusAttrList   *attr_list,
  * @index: Index of the @attr_list.
  * @returns: IBusAttribute at given index, NULL if no such IBusAttribute.
  *
- * Returns IBusAttribute at given index.
+ * Returns IBusAttribute at given index. Borrowed reference.
  */
 IBusAttribute       *ibus_attr_list_get         (IBusAttrList   *attr_list,
                                                  guint           index);

diff --git a/src/ibuslookuptable.h b/src/ibuslookuptable.h
index b5cb14e5aa5e4f812cb8cb85dc8ee809f91c081e..3d552b4519ca6c7e61245a00471fc68c28258282 100644 (file)
--- a/src/ibuslookuptable.h
+++ b/src/ibuslookuptable.h
@@ -113,7 +113,7 @@ IBusLookupTable     *ibus_lookup_table_new      (guint               page_size,
  * @table: An IBusLookupTable.
  * @text: candidate word/phrase to be appended (in IBusText format).
  *
- * Append a candidate word/phrase to IBusLookupTable.
+ * Append a candidate word/phrase to IBusLookupTable, and increase reference.
  */
 void                 ibus_lookup_table_append_candidate
                                                 (IBusLookupTable    *table,
@@ -125,7 +125,7 @@ void                 ibus_lookup_table_append_candidate
  * @index: Index in the Lookup table.
  * @returns: IBusText at the given index; NULL if no such IBusText.
  *
- * Return IBusText at the given index.
+ * Return IBusText at the given index. Borrowed reference.
  */
 IBusText            *ibus_lookup_table_get_candidate
                                                 (IBusLookupTable    *table,
@@ -136,7 +136,7 @@ IBusText            *ibus_lookup_table_get_candidate
  * @table: An IBusLookupTable.
  * @text: A candidate label to be appended (in IBusText format).
  *
- * Append a candidate word/phrase to IBusLookupTable.
+ * Append a candidate word/phrase to IBusLookupTable, and increase reference.
  * This function is needed if the input method select candidate with
  * non-numeric keys such as "asdfghjkl;".
  */
@@ -150,7 +150,7 @@ void                 ibus_lookup_table_append_label
  * @index: Index in the Lookup table.
  * @returns: IBusText at the given index; NULL if no such IBusText.
  *
- * Return IBusText at the given index.
+ * Return IBusText at the given index. Borrowed reference.
  */
 IBusText            *ibus_lookup_table_get_label
                                                 (IBusLookupTable    *table,

diff --git a/src/ibusproperty.h b/src/ibusproperty.h
index 3460bc24f01ef477edb76f39c6e34e70dba44172..ad0f0a076016ca11253a969fe13806783376e206 100644 (file)
--- a/src/ibusproperty.h
+++ b/src/ibusproperty.h
@@ -345,7 +345,7 @@ IBusPropList    *ibus_prop_list_new         ();
  * @prop_list: An IBusPropList.
  * @prop: IBusProperty to be append to @prop_list.
  *
- * Append an IBusProperty to an IBusPropList.
+ * Append an IBusProperty to an IBusPropList, and increase reference.
  */
 void             ibus_prop_list_append      (IBusPropList   *prop_list,
                                              IBusProperty   *prop);
@@ -356,7 +356,7 @@ void             ibus_prop_list_append      (IBusPropList   *prop_list,
  * @index: Index of an IBusPropList.
  * @returns: IBusProperty at given index, NULL if no such IBusProperty.
  *
- * Returns IBusProperty at given index.
+ * Returns IBusProperty at given index. Borrowed reference.
  */
 IBusProperty    *ibus_prop_list_get         (IBusPropList   *prop_list,
                                              guint           index);