doc: add api reference for "grn_obj_is_vector_column"

groonga · Jun 23, 2018 · b390d2d · b390d2d
1 parent 6ee54e9
commit b390d2d
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/doc/locale/ja/LC_MESSAGES/reference.po b/doc/locale/ja/LC_MESSAGES/reference.po
@@ -1507,6 +1507,17 @@ msgstr ""
 "外の場合は、 ``GRN_FALSE`` です。対象のオブジェクトがカラム以外の場合も "
 "``GRN_FALSE`` を返します。"
 
+msgid "Check whether vector column."
+msgstr "ベクターカラムかどうかを判定します。"
+
+msgid ""
+"``GRN_TRUE`` for if the target object is vector column, ``GRN_FALSE`` "
+"otherwise. Even if the target object isn't column, return ``GRN_FALSE``."
+msgstr ""
+"対象のオブジェクトがベクターカラムの場合には、 ``GRN_TRUE`` です。それ以外の"
+"場合は、 ``GRN_FALSE`` です。対象のオブジェクトがカラム以外の場合も "
+"``GRN_FALSE`` を返します。"
+
 msgid ""
 "objのIDに対応するレコードのvalueを取得します。valueを戻り値として返します。"
 msgstr ""

diff --git a/doc/source/reference/api/grn_obj.rst b/doc/source/reference/api/grn_obj.rst
@@ -47,6 +47,14 @@ Reference
    :param obj: The target object.
    :return: ``GRN_TRUE`` for if the target object is index column, ``GRN_FALSE`` otherwise. Even if the target object isn't column, return ``GRN_FALSE``.
 
+.. c:function:: grn_bool grn_obj_is_vector_column(grn_ctx *ctx, grn_obj *obj)
+
+   Check whether vector column.
+
+   :param ctx: The context object.
+   :param obj: The target object.
+   :return: ``GRN_TRUE`` for if the target object is vector column, ``GRN_FALSE`` otherwise. Even if the target object isn't column, return ``GRN_FALSE``.
+
 .. c:function:: grn_obj *grn_obj_get_value(grn_ctx *ctx, grn_obj *obj, grn_id id, grn_obj *value)
 
    objのIDに対応するレコードのvalueを取得します。valueを戻り値として返します。