Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: api/grn_db: move grn_obj_db() reference to the header file #1992

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 8, 2024
Merged

docs: api/grn_db: move grn_obj_db() reference to the header file #1992

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
466d4cc
docs: api/grn_db: move grn_obj_db() reference to the header file
abetomo Oct 8, 2024
8041e34
Update description
abetomo Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions doc/locale/ja/LC_MESSAGES/reference/api/grn_db.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=1; plural=0;\n"

msgid "パラメータ"
msgstr ""

msgid "``grn_db``"
msgstr ""

Expand All @@ -33,8 +30,5 @@ msgstr "例"
msgid "Reference"
msgstr "リファレンス"

msgid "objの属するdbを返します。"
msgstr ""

msgid "対象objectを指定します。"
msgstr ""
msgid "We are currently switching to automatic generation using Doxygen."
msgstr "現在、Doxygenを使った自動生成に切り替え中です。"
9 changes: 2 additions & 7 deletions doc/source/reference/api/grn_db.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,5 @@ TODO...
Reference
---------

TODO...

.. c:function:: grn_obj *grn_obj_db(grn_ctx *ctx, grn_obj *obj)

objの属するdbを返します。

:param obj: 対象objectを指定します。
.. note::
We are currently switching to automatic generation using Doxygen.
9 changes: 9 additions & 0 deletions include/groonga/groonga.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1348,6 +1348,15 @@ grn_obj_flush_only_opened(grn_ctx *ctx, grn_obj *obj);
GRN_API int
grn_obj_defrag(grn_ctx *ctx, grn_obj *obj, int threshold);

/**
* \brief Return the database to which `obj` belongs.
*
* \param ctx The context object.
* \param obj Target object.
*
* \return The database object to which `obj` belongs, `NULL` if `obj` doesn't
* belong to any database.
*/
GRN_API grn_obj *
grn_obj_db(grn_ctx *ctx, grn_obj *obj);

Expand Down
Loading