whombx
null+****@clear*****
Sun Aug 4 05:05:17 JST 2013
whombx 2013-08-04 05:05:17 +0900 (Sun, 04 Aug 2013) New Revision: 2f26b2586fce939bf64ba450efea04b0b7f2ed94 https://github.com/groonga/groonga/commit/2f26b2586fce939bf64ba450efea04b0b7f2ed94 Merged 6d867d5: Merge pull request #68 from whombx/grn-ctx-fin Message: doc: move grn_ctx_fin() 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 (+9 -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 05:05:17 +0900 (67179c8) @@ -48,6 +48,15 @@ Reference :param flags: 初期化する ``ctx`` のオプションを指定します。 :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error. +.. c:function:: grn_rc grn_ctx_fin(grn_ctx *ctx) + + ctxの管理するメモリを解放し、使用を終了します。 + + If ``ctx`` is initialized by :c:func:`grn_ctx_open()` not :c:func:`grn_ctx_init()`. You need also to call :c:func:`grn_ctx_close()`. + + :param ctx: 解放するctx構造体へのポインタを指定します。 + :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error. + .. c:function:: grn_ctx *grn_ctx_open(int flags) 初期化された :c:type:`grn_ctx` オブジェクトを返します。 Modified: include/groonga.h (+0 -11) =================================================================== --- include/groonga.h 2013-08-03 21:44:51 +0900 (a55eabb) +++ include/groonga.h 2013-08-04 05:05:17 +0900 (7a77747) @@ -220,18 +220,7 @@ struct _grn_ctx { #define GRN_CTX_PER_DB (0x08) GRN_API grn_rc grn_ctx_init(grn_ctx *ctx, int flags); - -/** - * grn_ctx_fin: - * @ctx: 解放するctx構造体へのポインタを指定します。 - * - * ctxの管理するメモリを解放し、使用を終了します。 - * - * If @ctx is initialized by grn_ctx_open() not - * grn_ctx_init(). You need also to call grn_ctx_close(). - **/ GRN_API grn_rc grn_ctx_fin(grn_ctx *ctx); - GRN_API grn_ctx *grn_ctx_open(int flags); /** -------------- next part -------------- HTML����������������������������...Download
