HAYASHI Kentaro
null+****@clear*****
Sun Aug 4 18:03:25 JST 2013
HAYASHI Kentaro 2013-08-04 18:03:25 +0900 (Sun, 04 Aug 2013) New Revision: f556d1555a7480d7b5ecec7ecc7268d498f287b6 https://github.com/groonga/groonga/commit/f556d1555a7480d7b5ecec7ecc7268d498f287b6 Message: doc: move grn_db_create() document to Sphinx text from header file Added files: doc/source/reference/api/grn_db.txt Modified files: doc/files.am include/groonga.h Modified: doc/files.am (+4 -0) =================================================================== --- doc/files.am 2013-08-04 17:40:46 +0900 (06d8c13) +++ doc/files.am 2013-08-04 18:03:25 +0900 (0668f02) @@ -348,6 +348,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/reference.txt \ $(top_srcdir)/doc/source/reference/api.txt \ $(top_srcdir)/doc/source/reference/api/grn_ctx.txt \ + $(top_srcdir)/doc/source/reference/api/grn_db.txt \ $(top_srcdir)/doc/source/reference/api/grn_expr.txt \ $(top_srcdir)/doc/source/reference/cast.txt \ $(top_srcdir)/doc/source/reference/command.txt \ @@ -810,6 +811,7 @@ source_files_relative_from_doc_dir = \ source/reference.txt \ source/reference/api.txt \ source/reference/api/grn_ctx.txt \ + source/reference/api/grn_db.txt \ source/reference/api/grn_expr.txt \ source/reference/cast.txt \ source/reference/command.txt \ @@ -1039,6 +1041,7 @@ html_files_relative_from_locale_dir = \ html/_sources/reference.txt \ html/_sources/reference/api.txt \ html/_sources/reference/api/grn_ctx.txt \ + html/_sources/reference/api/grn_db.txt \ html/_sources/reference/api/grn_expr.txt \ html/_sources/reference/cast.txt \ html/_sources/reference/command.txt \ @@ -1201,6 +1204,7 @@ html_files_relative_from_locale_dir = \ html/reference.html \ html/reference/api.html \ html/reference/api/grn_ctx.html \ + html/reference/api/grn_db.html \ html/reference/api/grn_expr.html \ html/reference/cast.html \ html/reference/command.html \ Added: doc/source/reference/api/grn_db.txt (+41 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/api/grn_db.txt 2013-08-04 18:03:25 +0900 (ccda26d) @@ -0,0 +1,41 @@ +.. -*- rst -*- + +.. highlightlang:: none + +``grn_db`` +========== + +Summary +------- + +TODO... + +.. c:type:: grn_db_create_optarg + +.. c:member:: builtin_type_names + + :c:type:`grn_db_create_optarg` のメンバ。組み込み型の名前となるnul終端文字列の配列を指定する。 + +.. c:member:: n_builtin_type_names + + :c:type:`grn_db_create_optarg` のメンバ。n_builtin_type_namesには、optarg.builtin_type_namesで指定する文字列の数を + 指定する。配列のoffsetはenum型grn_builtin_typeの値に対応する。 + +Example +------- + +TODO... + +Reference +--------- + +TODO... + +.. c:function:: grn_obj *grn_db_create(grn_ctx *ctx, const char *path, grn_db_create_optarg *optarg) + + 新たなdbを作成する。 + + :param ctx: 初期化済み :c:type:`grn_ctx` 。 + :param path: 作成するdbを格納するファイルパス。NULLならtemporary dbとなる。 + :param optarg: 作成するdbの組み込み型の名前を変更する時に指定する。 + Modified: include/groonga.h (+0 -12) =================================================================== --- include/groonga.h 2013-08-04 17:40:46 +0900 (8406077) +++ include/groonga.h 2013-08-04 18:03:25 +0900 (9626cd4) @@ -442,18 +442,6 @@ struct _grn_obj { #define GRN_OBJ_FIN(ctx,obj) (grn_obj_close((ctx), (obj))) -/** - * grn_db_create: - * @path: 作成するdbを格納するファイルパス。NULLならtemporary dbとなる。 - * NULL以外のパスを指定した場合はpersistent dbとなる。 - * @optarg: 作成するdbの組み込み型の名前を変更する時に指定する。 - * optarg.builtin_type_namesには組み込み型の名前となるnul終端文字列の配列を指定する。 - * optarg.n_builtin_type_namesには、optarg.builtin_type_namesで指定する文字列の数を - * 指定する。配列のoffsetはenum型grn_builtin_typeの値に対応する。 - * - * 新たなdbを作成する。 - **/ - typedef struct _grn_db_create_optarg grn_db_create_optarg; struct _grn_db_create_optarg { -------------- next part -------------- HTML����������������������������...Download