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

Back to archive index

whombx null+****@clear*****
Sun Aug 4 12:06:59 JST 2013


whombx	2013-08-04 12:06:59 +0900 (Sun, 04 Aug 2013)

  New Revision: d5435d824e567786382b645978117ede2fb84006
  https://github.com/groonga/groonga/commit/d5435d824e567786382b645978117ede2fb84006

  Merged 2e30702: Merge pull request #66 from whombx/grn-ctx-set-finalizer

  Message:
    doc: move grn_ctx_set_finalizer() 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 (+7 -0)
===================================================================
--- doc/source/reference/api/grn_ctx.txt    2013-08-04 10:50:34 +0900 (54ee740)
+++ doc/source/reference/api/grn_ctx.txt    2013-08-04 12:06:59 +0900 (c997838)
@@ -66,3 +66,10 @@ Reference
    :param ctx: no longer needed :c:type:`grn_ctx`.
    :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
 
+.. c:function:: grn_rc grn_ctx_set_finalizer(grn_ctx *ctx, grn_proc_func *func)
+
+   ctxを破棄するときに呼ばれる関数を設定します。
+
+   :param ctx: 対象ctxを指定します。
+   :param func: ``ctx`` を破棄するときに呼ばれる関数を指定します。
+   :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.

  Modified: include/groonga.h (+0 -8)
===================================================================
--- include/groonga.h    2013-08-04 10:50:34 +0900 (9b25d61)
+++ include/groonga.h    2013-08-04 12:06:59 +0900 (72e95e5)
@@ -234,14 +234,6 @@ GRN_API grn_rc grn_ctx_fin(grn_ctx *ctx);
 
 GRN_API grn_ctx *grn_ctx_open(int flags);
 GRN_API grn_rc grn_ctx_close(grn_ctx *ctx);
-
-/**
- * grn_ctx_set_finalizer:
- * @ctx: 対象ctx
- * @func: @ctxを破棄するときに呼ばれる関数
- *
- * @ctxを破棄するときに呼ばれる関数を設定する。
- **/
 GRN_API grn_rc grn_ctx_set_finalizer(grn_ctx *ctx, grn_proc_func *func);
 
 /**
-------------- next part --------------
HTML����������������������������...
Download 



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