whombx
null+****@clear*****
Sun Aug 4 14:45:53 JST 2013
whombx 2013-08-04 14:45:53 +0900 (Sun, 04 Aug 2013) New Revision: 5e4c8ab0aec357c1930720edab3e9b62b38a16a2 https://github.com/groonga/groonga/commit/5e4c8ab0aec357c1930720edab3e9b62b38a16a2 Merged 55bcb64: Merge pull request #69 from whombx/grn-ctx-use Message: doc: move all the rests of grn_ctx_*() documents 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 (+24 -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 14:45:53 +0900 (03201b8) @@ -66,3 +66,27 @@ 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_use(grn_ctx *ctx, grn_obj *db) + + ctxが操作対象とするdbを指定します。NULLを指定した場合は、dbを操作しない状態(init直後の状態)になります。 + + Don't use it with :c:type:`grn_ctx` that has ``GRN_CTX_PER_DB`` flag. + + :param db: ctxが使用するdbを指定します。 + +.. c:function:: grn_obj *grn_ctx_db(grn_ctx *ctx) + + ctxが現在操作対象としているdbを返します。dbを使用していない場合はNULLを返します。 + +.. c:function:: grn_obj *grn_ctx_get(grn_ctx *ctx, const char *name, int name_size) + + ctxが使用するdbからnameに対応するオブジェクトを検索して返す。nameに一致するオブジェクトが存在しなければNULLを返す。 + + :param name: 検索しようとするオブジェクトの名前。 + :param name_size: The number of bytes of name. If negative value is specified, name is assumed that NULL-terminated string. + +.. c:function:: grn_obj *grn_ctx_at(grn_ctx *ctx, grn_id id) + + ctx、またはctxが使用するdbからidに対応するオブジェクトを検索して返す。idに一致するオブジェクトが存在しなければNULLを返す。 + + :param id: 検索しようとするオブジェクトのidを指定します。 Modified: include/groonga.h (+0 -34) =================================================================== --- include/groonga.h 2013-08-04 10:50:34 +0900 (9b25d61) +++ include/groonga.h 2013-08-04 14:45:53 +0900 (ef898f9) @@ -531,44 +531,10 @@ GRN_API grn_obj *grn_db_open(grn_ctx *ctx, const char *path); **/ GRN_API void grn_db_touch(grn_ctx *ctx, grn_obj *db); -/** - * grn_ctx_use: - * @db: ctxが使用するdbを指定します。 - * - * ctxが操作対象とするdbを指定します。NULLを指定した場合は、 - * dbを操作しない状態(init直後の状態)になります。 - * - * Don't use it with grn_ctx that has GRN_CTX_PER_DB flag. - **/ GRN_API grn_rc grn_ctx_use(grn_ctx *ctx, grn_obj *db); - -/** - * grn_ctx_db: - * - * ctxが現在操作対象としているdbを返します。 - * dbを使用していない場合はNULLを返します。 - **/ GRN_API grn_obj *grn_ctx_db(grn_ctx *ctx); - -/** - * grn_ctx_get: - * @name: 検索しようとするオブジェクトの名前。 - * @name_size: The number of bytes of @name. If negative value is specified, - * @name is assumed that NULL-terminated string. - * - * ctxが使用するdbからnameに対応するオブジェクトを検索して返す。 - * nameに一致するオブジェクトが存在しなければNULLを返す。 - **/ GRN_API grn_obj *grn_ctx_get(grn_ctx *ctx, const char *name, int name_size); -/** - * grn_ctx_at: - * @id: 検索しようとするオブジェクトのid。 - * - * ctx、またはctxが使用するdbからidに対応するオブジェクトを検索して返す。 - * idに一致するオブジェクトが存在しなければNULLを返す。 - **/ - typedef enum { GRN_DB_VOID = 0, GRN_DB_DB, -------------- next part -------------- HTML����������������������������...下載
