[Groonga-commit] groonga/groonga at 6a785f0 [master] doc: move grn_ctx_close() document to Sphinx text from header file

Back to archive index

whombx null+****@clear*****
Sun Aug 4 06:18:20 JST 2013


whombx	2013-08-04 06:18:20 +0900 (Sun, 04 Aug 2013)

  New Revision: 6a785f08bdfc910cc3e80eaeaff40a87aaa3a54a
  https://github.com/groonga/groonga/commit/6a785f08bdfc910cc3e80eaeaff40a87aaa3a54a

  Merged 87ec10d: Merge pull request #65 from whombx/grn-ctx-close

  Message:
    doc: move grn_ctx_close() document to Sphinx text from header file

  Modified files:
    doc/source/reference/api/grn_ctx.txt
    include/groonga.h

  Modified: doc/source/reference/api/grn_ctx.txt (+8 -0)
===================================================================
--- doc/source/reference/api/grn_ctx.txt    2013-08-03 21:44:51 +0900 (4aefff6)
+++ doc/source/reference/api/grn_ctx.txt    2013-08-04 06:18:20 +0900 (54ee740)
@@ -58,3 +58,11 @@ Reference
 
    :param flags: 初期化する ``ctx`` のオプションを指定します。
    :return: 初期化された :c:type:`grn_ctx` オブジェクトを返します。
+
+.. c:function:: grn_rc grn_ctx_close(grn_ctx *ctx)
+
+   It calls :c:func:`grn_ctx_fin()` and frees allocated memory for ``ctx`` by :c:func:`grn_ctx_open()`.
+
+   :param ctx: no longer needed :c:type:`grn_ctx`.
+   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
+

  Modified: include/groonga.h (+0 -8)
===================================================================
--- include/groonga.h    2013-08-03 21:44:51 +0900 (a55eabb)
+++ include/groonga.h    2013-08-04 06:18:20 +0900 (9b25d61)
@@ -233,14 +233,6 @@ GRN_API grn_rc grn_ctx_init(grn_ctx *ctx, int flags);
 GRN_API grn_rc grn_ctx_fin(grn_ctx *ctx);
 
 GRN_API grn_ctx *grn_ctx_open(int flags);
-
-/**
- * grn_ctx_close:
- * @ctx: no longer needed grn_ctx.
- *
- * It calls grn_ctx_fin() and frees allocated memory for
- * @ctx by grn_ctx_open().
- **/
 GRN_API grn_rc grn_ctx_close(grn_ctx *ctx);
 
 /**
-------------- next part --------------
HTML����������������������������...
Télécharger 



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