Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: api/grn_ctx: move grn_ctx_at() reference to the header file
Browse files Browse the repository at this point in the history
GitHub: groongaGH-1817

Prepare to switch to documents automatically generated by Doxygen.
otegami committed Dec 4, 2024
1 parent e8cfa28 commit 141272f
Showing 3 changed files with 10 additions and 11 deletions.
6 changes: 0 additions & 6 deletions doc/locale/ja/LC_MESSAGES/reference/api/grn_ctx.po
Original file line number Diff line number Diff line change
@@ -41,9 +41,3 @@ msgstr ""

msgid "The number of bytes of name. If negative value is specified, name is assumed that NULL-terminated string."
msgstr "名前のバイト数。負の値が指定された場合は、終端をNULL文字とした文字列として扱われる。"

msgid "ctx、またはctxが使用するdbからidに対応するオブジェクトを検索して返す。idに一致するオブジェクトが存在しなければNULLを返す。"
msgstr ""

msgid "検索しようとするオブジェクトのidを指定します。"
msgstr ""
5 changes: 0 additions & 5 deletions doc/source/reference/api/grn_ctx.rst
Original file line number Diff line number Diff line change
@@ -25,8 +25,3 @@ Reference
:param name: 検索しようとするオブジェクトの名前。
:param name_size: The number of bytes of name. If negative value is specified, name is assumed that NULL-terminated string.
.. c:function:: grn_obj *grn_ctx_at(grn_ctx *ctx, grn_id id)
ctx、またはctxが使用するdbからidに対応するオブジェクトを検索して返す。idに一致するオブジェクトが存在しなければNULLを返す。
:param id: 検索しようとするオブジェクトのidを指定します。
10 changes: 10 additions & 0 deletions include/groonga/groonga.h
Original file line number Diff line number Diff line change
@@ -1005,6 +1005,16 @@ typedef enum {
GRN_DB_TRIGRAM
} grn_builtin_tokenizer;

/**
* \brief Retrieve the object corresponding to the specified ID from the context
* or the database that the context is using.
*
* \param ctx The context object.
* \param id The object ID to be retrieved.
*
* \return \ref grn_obj if the object that has the specified ID is found, `NULL`
* otherwise.
*/
GRN_API grn_obj *
grn_ctx_at(grn_ctx *ctx, grn_id id);
/*

0 comments on commit 141272f

Please sign in to comment.