whombx
null+****@clear*****
Fri Aug 9 18:58:15 JST 2013
whombx 2013-08-09 18:58:15 +0900 (Fri, 09 Aug 2013) New Revision: f22862cba9667e573b163a8c3387cb028dc568c1 https://github.com/groonga/groonga/commit/f22862cba9667e573b163a8c3387cb028dc568c1 Merged 12cccad: Merge pull request #84 from whombx/grn-info Message: doc: move grn_info documents from groonga.h to Sphinx text Added files: doc/source/reference/api/grn_info.txt Modified files: doc/files.am include/groonga.h Modified: doc/files.am (+4 -0) =================================================================== --- doc/files.am 2013-08-09 17:41:07 +0900 (41ed970) +++ doc/files.am 2013-08-09 18:58:15 +0900 (3ecadb9) @@ -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_info.txt \ $(top_srcdir)/doc/source/reference/api/grn_obj.txt \ $(top_srcdir)/doc/source/reference/api/grn_proc.txt \ $(top_srcdir)/doc/source/reference/api/grn_table.txt \ @@ -821,6 +822,7 @@ source_files_relative_from_doc_dir = \ source/reference/api/grn_db.txt \ source/reference/api/grn_expr.txt \ source/reference/api/grn_index_cursor.txt \ + source/reference/api/grn_info.txt \ source/reference/api/grn_obj.txt \ source/reference/api/grn_table.txt \ source/reference/api/grn_table_cursor.txt \ @@ -1057,6 +1059,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_info.txt \ html/_sources/reference/api/grn_obj.txt \ html/_sources/reference/api/grn_proc.txt \ html/_sources/reference/api/grn_table.txt \ @@ -1226,6 +1229,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_info.html \ html/reference/api/grn_obj.html \ html/reference/api/grn_proc.html \ html/reference/api/grn_table.html \ Added: doc/source/reference/api/grn_info.txt (+56 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/api/grn_info.txt 2013-08-09 18:58:15 +0900 (773b36a) @@ -0,0 +1,56 @@ +.. -*- rst -*- + +.. highlightlang:: none + +``grn_info`` +============ + +Summary +------- + +TODO... + +Example +------- + +TODO... + +Reference +--------- + +.. c:type:: grn_info_type + + TODO... + +.. c:function:: grn_obj *grn_obj_get_info(grn_ctx *ctx, grn_obj *obj, grn_info_type type, grn_obj *valuebuf) + + objのtypeに対応する情報をvaluebufに格納します。 + + :param obj: 対象objを指定します。 + :param type: 取得する情報の種類を指定します。 + :param valuebuf: 値を格納するバッファ（呼出側で準備）を指定します。 + +.. c:function:: grn_rc grn_obj_set_info(grn_ctx *ctx, grn_obj *obj, grn_info_type type, grn_obj *value) + + objのtypeに対応する情報をvalueの内容に更新します。 + + :param obj: 対象objを指定します。 + :param type: 設定する情報の種類を指定します。 + +.. c:function:: grn_obj *grn_obj_get_element_info(grn_ctx *ctx, grn_obj *obj, grn_id id, grn_info_type type, grn_obj *value) + + objのidに対応するレコードの、typeに対応する情報をvaluebufに格納します。呼出側ではtypeに応じて十分なサイズのバッファを確保しなければいけません。 + + :param obj: 対象objを指定します。 + :param id: 対象IDを指定します。 + :param type: 取得する情報の種類を指定します。 + :param value: 値を格納するバッファ（呼出側で準備）を指定します。 + +.. c:function:: grn_rc grn_obj_set_element_info(grn_ctx *ctx, grn_obj *obj, grn_id id, grn_info_type type, grn_obj *value) + + objのidに対応するレコードのtypeに対応する情報をvalueの内容に更新します。 + + :param obj: 対象objectを指定します。 + :param id: 対象IDを指定します。 + :param type: 設定する情報の種類を指定します。 + :param value: 設定しようとする値を指定します。 Modified: include/groonga.h (+0 -38) =================================================================== --- include/groonga.h 2013-08-09 17:41:07 +0900 (2d6d589) +++ include/groonga.h 2013-08-09 18:58:15 +0900 (1964089) @@ -835,48 +835,10 @@ typedef enum { GRN_INFO_NORMALIZER } grn_info_type; -/** - * grn_obj_get_info: - * @obj: 対象obj - * @type: 取得する情報の種類 - * @valuebuf: 値を格納するバッファ(呼出側で準備) - * - * objのtypeに対応する情報をvaluebufに格納する。 - **/ GRN_API grn_obj *grn_obj_get_info(grn_ctx *ctx, grn_obj *obj, grn_info_type type, grn_obj *valuebuf); - -/** - * grn_obj_set_info: - * @obj: 対象obj - * @type: 設定する情報の種類 - * @value: 設定しようとする値 - * - * objのtypeに対応する情報をvalueの内容に更新する。 - **/ GRN_API grn_rc grn_obj_set_info(grn_ctx *ctx, grn_obj *obj, grn_info_type type, grn_obj *value); - -/** - * grn_obj_get_element_info: - * @obj: 対象obj - * @id: 対象ID - * @type: 取得する情報の種類 - * @value: 値を格納するバッファ(呼出側で準備) - * - * objのidに対応するレコードの、typeに対応する情報をvaluebufに格納する。 - * 呼出側ではtypeに応じて十分なサイズのバッファを確保しなければならない。 - **/ GRN_API grn_obj *grn_obj_get_element_info(grn_ctx *ctx, grn_obj *obj, grn_id id, grn_info_type type, grn_obj *value); - -/** - * grn_obj_set_element_info: - * @obj: 対象object - * @id: 対象ID - * @type: 設定する情報の種類 - * @value: 設定しようとする値 - * - * objのidに対応するレコードのtypeに対応する情報をvalueの内容に更新する。 - **/ GRN_API grn_rc grn_obj_set_element_info(grn_ctx *ctx, grn_obj *obj, grn_id id, grn_info_type type, grn_obj *value); -------------- next part -------------- HTML����������������������������...Download