HAYASHI Kentaro
null+****@clear*****
Fri Aug 9 17:06:49 JST 2013
HAYASHI Kentaro 2013-08-09 17:06:49 +0900 (Fri, 09 Aug 2013) New Revision: 22a9997b1883d73ff3a7309a3352a80bbad062ab https://github.com/groonga/groonga/commit/22a9997b1883d73ff3a7309a3352a80bbad062ab Message: doc: move grn_proc_create() and grn_proc_get_info() document from groonga.h to Sphinx text GitHub: #78 Patch by whombx. Thanks!!! Added files: doc/source/reference/api/grn_proc.txt Modified files: doc/files.am include/groonga.h Modified: doc/files.am (+4 -0) =================================================================== --- doc/files.am 2013-08-09 16:27:53 +0900 (801495d) +++ doc/files.am 2013-08-09 17:06:49 +0900 (acf6976) @@ -352,6 +352,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/reference/api/grn_db.txt \ $(top_srcdir)/doc/source/reference/api/grn_expr.txt \ $(top_srcdir)/doc/source/reference/api/grn_index_cursor.txt \ + $(top_srcdir)/doc/source/reference/api/grn_proc.txt \ $(top_srcdir)/doc/source/reference/api/grn_table.txt \ $(top_srcdir)/doc/source/reference/api/grn_table_cursor.txt \ $(top_srcdir)/doc/source/reference/cast.txt \ @@ -821,6 +822,7 @@ source_files_relative_from_doc_dir = \ source/reference/api/grn_index_cursor.txt \ source/reference/api/grn_table.txt \ source/reference/api/grn_table_cursor.txt \ + source/reference/api/grn_proc.txt \ source/reference/cast.txt \ source/reference/command.txt \ source/reference/command/command_version.txt \ @@ -1053,6 +1055,7 @@ html_files_relative_from_locale_dir = \ html/_sources/reference/api/grn_db.txt \ html/_sources/reference/api/grn_expr.txt \ html/_sources/reference/api/grn_index_cursor.txt \ + html/_sources/reference/api/grn_proc.txt \ html/_sources/reference/api/grn_table.txt \ html/_sources/reference/api/grn_table_cursor.txt \ html/_sources/reference/cast.txt \ @@ -1220,6 +1223,7 @@ html_files_relative_from_locale_dir = \ html/reference/api/grn_db.html \ html/reference/api/grn_expr.html \ html/reference/api/grn_index_cursor.html \ + html/reference/api/grn_proc.html \ html/reference/api/grn_table.html \ html/reference/api/grn_table_cursor.html \ html/reference/cast.html \ Added: doc/source/reference/api/grn_proc.txt (+48 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/api/grn_proc.txt 2013-08-09 17:06:49 +0900 (7bc5f39) @@ -0,0 +1,48 @@ +.. -*- rst -*- + +.. highlightlang:: none + +``grn_proc`` +============ + +Summary +------- + +TODO... + +Example +------- + +TODO... + +Reference +--------- + +.. c:type:: grn_proc_type + + TODO... + +.. c:type:: grn_proc_func + + TODO... + +.. c:function:: grn_obj *grn_proc_create(grn_ctx *ctx, const char *name, int name_size, grn_proc_type type, grn_proc_func *init, grn_proc_func *next, grn_proc_func *fin, unsigned int nvars, grn_expr_var *vars) + + nameに対応する新たなproc(手続き)をctxが使用するdbに定義します。 + + :param name: 作成するprocの名前を指定します。 + :param name_size: The number of bytes of name parameter. If negative value is specified, name parameter is assumed that NULL-terminated string. + :param type: procの種類を指定します。 + :param init: 初期化関数のポインタを指定します。 + :param next: 実処理関数のポインタを指定します。 + :param fin: 終了関数のポインタを指定します。 + :param nvars: procで使用する変数の数を指定します。 + :param vars: procで使用する変数の定義を指定します。( :c:type:`grn_expr_var` 構造体の配列) + +.. c:function:: grn_obj *grn_proc_get_info(grn_ctx *ctx, grn_user_data *user_data, grn_expr_var **vars, unsigned int *nvars, grn_obj **caller) + + user_dataをキーとして、現在実行中の :c:type:`grn_proc_func` 関数および定義されている変数( :c:type:`grn_expr_var` )の配列とその数を取得します。 + + :param user_data: :c:type:`grn_proc_func` に渡されたuser_dataを指定します。 + :param nvars: 変数の数を取得します。 + Modified: include/groonga.h (+0 -24) =================================================================== --- include/groonga.h 2013-08-09 16:27:53 +0900 (2d4f815) +++ include/groonga.h 2013-08-09 17:06:49 +0900 (bc82f7f) @@ -512,21 +512,6 @@ GRN_API grn_rc grn_plugin_register_by_path(grn_ctx *ctx, const char *path); GRN_API const char *grn_plugin_get_system_plugins_dir(void); GRN_API const char *grn_plugin_get_suffix(void); -/** - * grn_proc_create: - * @name: 作成するprocの名前。 - * @name_size: The number of bytes of @name. If negative value is specified, - * @name is assumed that NULL-terminated string. - * @type: procの種類。 - * @init: 初期化関数のポインタ - * @next: 実処理関数のポインタ - * @fin: 終了関数のポインタ - * @nvars: procで使用する変数の数 - * @vars: procで使用する変数の定義(grn_expr_var構造体の配列) - * - * nameに対応する新たなproc(手続き)をctxが使用するdbに定義する。 - **/ - typedef struct { const char *name; unsigned int name_size; @@ -547,15 +532,6 @@ GRN_API grn_obj *grn_proc_create(grn_ctx *ctx, const char *name, int name_size, grn_proc_type type, grn_proc_func *init, grn_proc_func *next, grn_proc_func *fin, unsigned int nvars, grn_expr_var *vars); -/** - * grn_proc_vars: - * @user_data: grn_proc_funcに渡されたuser_data - * @nvars: 変数の数 - * - * user_dataをキーとして、現在実行中のgrn_proc_func関数および - * 定義されている変数(grn_expr_var)の配列とその数を取得する。 - **/ - GRN_API grn_obj *grn_proc_get_info(grn_ctx *ctx, grn_user_data *user_data, grn_expr_var **vars, unsigned int *nvars, grn_obj **caller); -------------- next part -------------- HTML����������������������������...Download