Navigation Menu

Skip to content

Commit

Permalink
doc: add api reference for "grn_obj_is_index_column"
Browse files Browse the repository at this point in the history
  • Loading branch information
komainu8 committed Jun 21, 2018
1 parent 57cf8ad commit 6ee54e9
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc/locale/ja/LC_MESSAGES/reference.po
Expand Up @@ -1493,6 +1493,20 @@ msgstr ""
msgid "``GRN_TRUE`` for built-in groonga object, ``GRN_FALSE`` otherwise."
msgstr ""

msgid "Check whether index column."
msgstr "インデックスカラムかどうかを判定します。"

msgid "The target object."
msgstr "対象のオブジェクト"

msgid ""
"``GRN_TRUE`` for if the target object is index 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 ""
Expand Down
8 changes: 8 additions & 0 deletions doc/source/reference/api/grn_obj.rst
Expand Up @@ -39,6 +39,14 @@ Reference
:param obj: target object
:return: ``GRN_TRUE`` for built-in groonga object, ``GRN_FALSE`` otherwise.
.. c:function:: grn_bool grn_obj_is_index_column(grn_ctx *ctx, grn_obj *obj)
Check whether index column.
:param ctx: The context object.
: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_obj *grn_obj_get_value(grn_ctx *ctx, grn_obj *obj, grn_id id, grn_obj *value)
objのIDに対応するレコードのvalueを取得します。valueを戻り値として返します。
Expand Down

0 comments on commit 6ee54e9

Please sign in to comment.