docs: api/cache move grn_cache_current_get() reference to the header file

GitHub: groongaGH-1817

Prepare to switch to documents automatically generated by Doxygen.

Author: otegami

doc/locale/ja/LC_MESSAGES/reference/api/grn_cache.po

@@ -65,9 +65,3 @@ msgstr ":doc:`/reference/commands/select` コマンドで使われるキャッ
 
 msgid "``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` otherwise."
 msgstr "成功時は ``GRN_SUCCESS`` 、エラー時は ``GRN_SUCCESS`` 以外。"
-
-msgid "Gets the cache object that is used in :doc:`/reference/commands/select` command."
-msgstr ":doc:`/reference/commands/select` コマンドで使われるキャッシュオブジェクトを取得します。"
-
-msgid "The cache object that is used in :doc:`/reference/commands/select` command. It may be ``NULL``."
-msgstr ":doc:`/reference/commands/select` コマンドで使われるキャッシュオブジェクト。 ``NULL`` のこともあります。"

doc/source/reference/api/grn_cache.rst

@@ -66,12 +66,3 @@ Reference
    :param cache: The cache object that is used in
                  :doc:`/reference/commands/select` command.
    :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` otherwise.
-
-.. c:function:: grn_cache *grn_cache_current_get(grn_ctx *ctx)
-
-   Gets the cache object that is used in
-   :doc:`/reference/commands/select` command.
-
-   :param ctx: The context.
-   :return: The cache object that is used in
-            :doc:`/reference/commands/select` command. It may be ``NULL``.

include/groonga/cache.h

@@ -95,6 +95,21 @@ grn_cache_close(grn_ctx *ctx, grn_cache *cache);
 
 GRN_API grn_rc
 grn_cache_current_set(grn_ctx *ctx, grn_cache *cache);
+/**
+ * \brief Retrieve the current \ref grn_cache object used in the select command.
+ *
+ * \note For more details about the select command, please see
+ * \htmlonly
+ *   <a href="https://groonga.org/docs/reference/commands/select.html">
+ *     Groonga command select documentation
+ *   </a>.
+ * \endhtmlonly
+ *
+ * \param ctx The context object.
+ *
+ * \return The \ref grn_cache object used in the select command on success,
+ *         `NULL` on error.
+ */
 GRN_API grn_cache *
 grn_cache_current_get(grn_ctx *ctx);