whombx
null+****@clear*****
Fri Aug 9 20:55:55 JST 2013
whombx 2013-08-09 20:55:55 +0900 (Fri, 09 Aug 2013) New Revision: 63aff5c70123929f3ef9d0fcb585a1cdb2923098 https://github.com/groonga/groonga/commit/63aff5c70123929f3ef9d0fcb585a1cdb2923098 Merged aec1891: Merge branch 'grn-obj-close' of https://github.com/whombx/groonga into whombx-grn-obj-close Message: doc: move grn_obj_close(), grn_obj_reinit() and grn_obj_unlink() documents from groonga.h to Sphinx text Modified files: doc/source/reference/api/grn_obj.txt include/groonga.h Modified: doc/source/reference/api/grn_obj.txt (+23 -0) =================================================================== --- doc/source/reference/api/grn_obj.txt 2013-08-09 17:41:07 +0900 (f0d4f5d) +++ doc/source/reference/api/grn_obj.txt 2013-08-09 20:55:55 +0900 (d69dcf4) @@ -31,3 +31,26 @@ Reference :param table: 対象tableを指定します。 :param name: カラム名を指定します。 +.. c:function:: grn_rc grn_obj_close(grn_ctx *ctx, grn_obj *obj) + + 一時的なobjectであるobjをメモリから解放します。objに属するobjectも再帰的にメモリから解放されます。 + + 永続的な、table, column, exprなどは解放してはいけません。一般的には、一時的か永続的かを気にしなくてよい :c:func:`grn_obj_unlink()` を用いるべきです。 + + :param obj: 対象objectを指定します。 + +.. c:function:: grn_rc grn_obj_reinit(grn_ctx *ctx, grn_obj *obj, grn_id domain, unsigned char flags) + + objの型を変更します。 + + objは :c:func:`GRN_OBJ_INIT()` マクロなどで初期化済みでなければいけません。 + + :param obj: 対象objectを指定します。 + :param domain: 変更後のobjの型を指定します。 + :param flags: ``GRN_OBJ_VECTOR`` を指定するとdomain型の値のベクタを格納するオブジェクトになります。 + +.. c:function:: void grn_obj_unlink(grn_ctx *ctx, grn_obj *obj) + + objをメモリから解放します。objに属するobjectも再帰的にメモリから解放されます。 + + :param obj: 対象objectを指定します。 Modified: include/groonga.h (+0 -26) =================================================================== --- include/groonga.h 2013-08-09 17:41:07 +0900 (2d6d589) +++ include/groonga.h 2013-08-09 20:55:55 +0900 (e046347) @@ -998,34 +998,8 @@ GRN_API grn_rc grn_table_rename(grn_ctx *ctx, grn_obj *table, GRN_API grn_rc grn_column_rename(grn_ctx *ctx, grn_obj *column, const char *name, unsigned int name_size); -/** - * grn_obj_close: - * @obj: 対象object - * - * 一時的なobjectであるobjをメモリから解放する。 - * objに属するobjectも再帰的にメモリから解放される。 - * 永続的な、table・column・exprなどは解放してはならない。 - * 一般的には、一時的か永続的かを気にしなくてよいgrn_obj_unlinkを用いるべき。 - **/ GRN_API grn_rc grn_obj_close(grn_ctx *ctx, grn_obj *obj); - -/** - * grn_obj_reinit: - * @obj: 対象object - * @domain: 変更後のobjの型 - * @flags: GRN_OBJ_VECTORを指定するとdomain型の値のベクタを格納するオブジェクトになる。 - * - * objの型を変更する。objはGRN_OBJ_INITマクロなどで初期化済みでなければならない。 - **/ GRN_API grn_rc grn_obj_reinit(grn_ctx *ctx, grn_obj *obj, grn_id domain, unsigned char flags); - -/** - * grn_obj_unlink: - * @obj: 対象object - * - * objをメモリから解放する。 - * objに属するobjectも再帰的にメモリから解放される。 - **/ GRN_API void grn_obj_unlink(grn_ctx *ctx, grn_obj *obj); /** -------------- next part -------------- HTML����������������������������...Download
