whombx
null+****@clear*****
Fri Aug 9 18:22:12 JST 2013
whombx 2013-08-09 18:22:12 +0900 (Fri, 09 Aug 2013) New Revision: 74aab5de70110d636c457a3a250075b5e04c609e https://github.com/groonga/groonga/commit/74aab5de70110d636c457a3a250075b5e04c609e Merged faf79f7: Merge pull request #83 from whombx/grn-encoding Message: doc: move grn_encoding documents from groonga.h to Sphinx text Added files: doc/source/reference/api/grn_encoding.txt Modified files: doc/files.am include/groonga.h Modified: doc/files.am (+4 -0) =================================================================== --- doc/files.am 2013-08-09 17:06:49 +0900 (acf6976) +++ doc/files.am 2013-08-09 18:22:12 +0900 (f102c13) @@ -350,6 +350,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/reference/api/grn_column.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_encoding.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 \ @@ -818,6 +819,7 @@ source_files_relative_from_doc_dir = \ source/reference/api/grn_column.txt \ source/reference/api/grn_ctx.txt \ source/reference/api/grn_db.txt \ + source/reference/api/grn_encoding.txt \ source/reference/api/grn_expr.txt \ source/reference/api/grn_index_cursor.txt \ source/reference/api/grn_table.txt \ @@ -1053,6 +1055,7 @@ html_files_relative_from_locale_dir = \ html/_sources/reference/api/grn_column.txt \ html/_sources/reference/api/grn_ctx.txt \ html/_sources/reference/api/grn_db.txt \ + html/_sources/reference/api/grn_encoding.txt \ html/_sources/reference/api/grn_expr.txt \ html/_sources/reference/api/grn_index_cursor.txt \ html/_sources/reference/api/grn_proc.txt \ @@ -1221,6 +1224,7 @@ html_files_relative_from_locale_dir = \ html/reference/api/grn_column.html \ html/reference/api/grn_ctx.html \ html/reference/api/grn_db.html \ + html/reference/api/grn_encoding.html \ html/reference/api/grn_expr.html \ html/reference/api/grn_index_cursor.html \ html/reference/api/grn_proc.html \ Added: doc/source/reference/api/grn_encoding.txt (+49 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/api/grn_encoding.txt 2013-08-09 18:22:12 +0900 (f997fc2) @@ -0,0 +1,49 @@ +.. -*- rst -*- + +.. highlightlang:: none + +``grn_encoding`` +================ + +Summary +------- + +TODO... + +Example +------- + +TODO... + +Reference +--------- + +.. c:type:: grn_encoding + + TODO... + +.. c:function:: grn_encoding grn_get_default_encoding(void) + + デフォルトのencodingを返します。 + +.. c:function:: grn_rc grn_set_default_encoding(grn_encoding encoding) + + デフォルトのencodingを変更します。 + + :param encoding: 変更後のデフォルトのencodingを指定します。 + +.. c:function:: const char *grn_encoding_to_string(grn_encoding encoding) + + Returns string representation for the encoding. For example, 'grn_encoding_to_string(``GRN_ENC_UTF8``)' returns '"utf8"'. + + "unknown" is returned for invalid encoding. + + :param encoding: The encoding. + +.. c:function:: grn_encoding grn_encoding_parse(const char *name) + + Parses encoding name and returns grn_encoding. For example, 'grn_encoding_parse("UTF8")' returns '``GRN_ENC_UTF8``'. + + ``GRN_ENC_UTF8`` is returned for invalid encoding name. + + :param name: The encoding name. Modified: include/groonga.h (+1 -31) =================================================================== --- include/groonga.h 2013-08-09 17:06:49 +0900 (bc82f7f) +++ include/groonga.h 2013-08-09 18:22:12 +0900 (0e161b2) @@ -225,19 +225,7 @@ GRN_API grn_ctx *grn_ctx_open(int flags); GRN_API grn_rc grn_ctx_close(grn_ctx *ctx); GRN_API grn_rc grn_ctx_set_finalizer(grn_ctx *ctx, grn_proc_func *func); -/** - * grn_get_default_encoding: - * - * デフォルトのencodingを返します。 - **/ GRN_API grn_encoding grn_get_default_encoding(void); - -/** - * grn_set_default_encoding: - * @encoding: 変更後のデフォルトのencodingを指定します。 - * - * デフォルトのencodingを変更します。 - **/ GRN_API grn_rc grn_set_default_encoding(grn_encoding encoding); #define GRN_CTX_GET_ENCODING(ctx) ((ctx)->encoding) @@ -287,26 +275,8 @@ GRN_API long long int grn_get_default_match_escalation_threshold(void); GRN_API grn_rc grn_set_default_match_escalation_threshold(long long int threshold); /* grn_encoding */ -/** - * grn_encoding_to_string: - * @encoding: The encoding. - * - * Returns string representation for the encoding. For example, - * 'grn_encoding_to_string(GRN_ENC_UTF8)' returns '"utf8"'. - * - * "unknown" is returned for invalid encoding. - **/ -GRN_API const char *grn_encoding_to_string(grn_encoding encoding); -/** - * grn_encoding_parse: - * @name: The encoding name. - * - * Parses encoding name and returns grn_encoding. - * For example, 'grn_encoding_to_string("UTF8")' returns 'GRN_ENC_UTF8'. - * - * 'GRN_ENC_UTF8' is returned for invalid encoding name. - **/ +GRN_API const char *grn_encoding_to_string(grn_encoding encoding); GRN_API grn_encoding grn_encoding_parse(const char *name); /* obj */ -------------- next part -------------- HTML����������������������������...Télécharger
