[Groonga-commit] groonga/groonga at b390d2d [master] doc: add api reference for "grn_obj_is_vector_column"

Back to archive index

Yasuhiro Horimoto null+****@clear*****
Sat Jun 23 11:46:08 JST 2018


Yasuhiro Horimoto	2018-06-23 11:46:08 +0900 (Sat, 23 Jun 2018)

  New Revision: b390d2d9abe55ceba9bfd55cfb58eec493d6bd0c
  https://github.com/groonga/groonga/commit/b390d2d9abe55ceba9bfd55cfb58eec493d6bd0c

  Merged dec278a: Merge pull request #856 from komainu8/add_api_document

  Message:
    doc: add api reference for "grn_obj_is_vector_column"

  Modified files:
    doc/locale/ja/LC_MESSAGES/reference.po
    doc/source/reference/api/grn_obj.rst

  Modified: doc/locale/ja/LC_MESSAGES/reference.po (+11 -0)
===================================================================
--- doc/locale/ja/LC_MESSAGES/reference.po    2018-06-21 14:56:12 +0900 (b1bba8d1c)
+++ doc/locale/ja/LC_MESSAGES/reference.po    2018-06-23 11:46:08 +0900 (67151b048)
@@ -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 ""

  Modified: doc/source/reference/api/grn_obj.rst (+8 -0)
===================================================================
--- doc/source/reference/api/grn_obj.rst    2018-06-21 14:56:12 +0900 (959f8752c)
+++ doc/source/reference/api/grn_obj.rst    2018-06-23 11:46:08 +0900 (1b79abc4c)
@@ -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を戻り値として返します。
-------------- next part --------------
HTML����������������������������...
URL: https://lists.osdn.me/mailman/archives/groonga-commit/attachments/20180623/e3dfd0ea/attachment-0001.htm 



More information about the Groonga-commit mailing list
Back to archive index