whombx
null+****@clear*****
Mon Jul 29 22:03:43 JST 2013
whombx 2013-07-29 22:03:43 +0900 (Mon, 29 Jul 2013) New Revision: f513f5449e942c2fb138ba9b4fcd0b4001cc1dd6 https://github.com/groonga/groonga/commit/f513f5449e942c2fb138ba9b4fcd0b4001cc1dd6 Merged bf34985: Merge pull request #64 from whombx/grn-ctx-open Message: doc: move grn_ctx_open() 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 (+11 -0) =================================================================== --- doc/source/reference/api/grn_ctx.txt 2013-07-29 15:22:29 +0900 (19279ee) +++ doc/source/reference/api/grn_ctx.txt 2013-07-29 22:03:43 +0900 (4aefff6) @@ -47,3 +47,14 @@ Reference :param ctx: 初期化するctx構造体へのポインタを指定します。 :param flags: 初期化する ``ctx`` のオプションを指定します。 :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error. + +.. c:function:: grn_ctx *grn_ctx_open(int flags) + + 初期化された :c:type:`grn_ctx` オブジェクトを返します。 + + :c:func:`grn_ctx_init()` で初期化された :c:type:`grn_ctx` オブジェクトは構造体の実体をAPIの呼び元で確保するのに対して、 :c:func:`grn_ctx_open()` ではgroongaライブラリの内部で、実体を確保します。 + どちらで初期化された :c:type:`grn_ctx` も、 :c:func:`grn_ctx_fin()` で解放できます。 + :c:func:`grn_ctx_open()` で確保した :c:type:`grn_ctx` 構造体に関しては、:c:func:`grn_ctx_fin()` で解放した後に、その :c:type:`grn_ctx` で作成した :c:type:`grn_obj` を :c:func:`grn_obj_close()` によって解放しても問題ありません。 + + :param flags: 初期化する ``ctx`` のオプションを指定します。 + :return: 初期化された :c:type:`grn_ctx` オブジェクトを返します。 Modified: include/groonga.h (+0 -13) =================================================================== --- include/groonga.h 2013-07-29 15:22:29 +0900 (6443a62) +++ include/groonga.h 2013-07-29 22:03:43 +0900 (a55eabb) @@ -232,19 +232,6 @@ GRN_API grn_rc grn_ctx_init(grn_ctx *ctx, int flags); **/ GRN_API grn_rc grn_ctx_fin(grn_ctx *ctx); -/** - * grn_ctx_open: - * @flags: 初期化するctxのオプションを指定します。 - * - * - * 初期化されたgrn_ctxオブジェクトを返します。 - * grn_ctx_initで初期化されたgrn_ctxオブジェクトは構造体の実体を - * APIの呼び元で確保するのに対して、grn_ctx_openではgroongaライブラリの内部で、 - * 実体を確保します。どちらで初期化されたgrn_ctxも、grn_ctx_fin()で解放できます。 - * grn_ctx_openで確保したgrn_ctx構造体に関しては、grn_ctx_fin()で解放した後に、 - * そのgrn_ctxで作成したgrn_objをgrn_obj_close()によって解放しても問題ありません。 - **/ - GRN_API grn_ctx *grn_ctx_open(int flags); /** -------------- next part -------------- HTML����������������������������...Download