[Groonga-commit] groonga/groonga at afb1e45 [master] doc: move grn_ctx_get_command_version(), grn_ctx_set_command_version(), grn_ctx_get_match_escalation_threshold() and grn_ctx_set_match_escalation_threshold() document to Sphinx text from header file

アーカイブの一覧に戻る

whombx null+****@clear*****
Sun Aug 4 12:42:47 JST 2013


whombx	2013-08-04 12:42:47 +0900 (Sun, 04 Aug 2013)

  New Revision: afb1e4517249015c6cd7ed8bd5bce8de99a5c26c
  https://github.com/groonga/groonga/commit/afb1e4517249015c6cd7ed8bd5bce8de99a5c26c

  Merged def53b3: Merge pull request #67 from whombx/grn-ctx-get-command-version

  Message:
    doc: move grn_ctx_get_command_version(), grn_ctx_set_command_version(), grn_ctx_get_match_escalation_threshold() and grn_ctx_set_match_escalation_threshold() document 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 (+23 -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 12:42:47 +0900 (ae40e79)
@@ -66,3 +66,26 @@ Reference
    :param ctx: no longer needed :c:type:`grn_ctx`.
    :return: ``GRN_SUCCESS`` on success, not ``GRN_SUCCESS`` on error.
 
+.. c:function:: grn_command_version grn_ctx_get_command_version(grn_ctx *ctx)
+ 
+   command_versionを返します。
+
+.. c:function:: grn_rc grn_ctx_set_command_version(grn_ctx *ctx, grn_command_version version)
+
+   command_versionを変更します。
+
+   :param version: 変更後のcommand_versionを指定します。
+
+.. c:function:: long long int grn_ctx_get_match_escalation_threshold(grn_ctx *ctx)
+
+   検索の挙動をエスカレーションする閾値を返します。
+
+   エスカレーションの詳細は検索の仕様に関するドキュメントを参照してください。
+
+.. c:function:: grn_rc grn_ctx_set_match_escalation_threshold(grn_ctx *ctx, long long int threshold)
+
+   検索の挙動をエスカレーションする閾値を変更します。
+
+   エスカレーションの詳細は検索の仕様に関するドキュメントを参照してください。
+
+   :param threshold: 変更後の検索の挙動をエスカレーションする閾値を指定します。

  Modified: include/groonga.h (+0 -29)
===================================================================
--- include/groonga.h    2013-08-04 10:50:34 +0900 (9b25d61)
+++ include/groonga.h    2013-08-04 12:42:47 +0900 (05da830)
@@ -281,38 +281,9 @@ GRN_API grn_command_version grn_get_default_command_version(void);
  **/
 GRN_API grn_rc grn_set_default_command_version(grn_command_version version);
 
-/**
- * grn_ctx_get_command_version:
- *
- * command_versionを返します。
- **/
 GRN_API grn_command_version grn_ctx_get_command_version(grn_ctx *ctx);
-
-/**
- * grn_ctx_set_command_version:
- * @version: 変更後のcommand_versionを指定します。
- *
- * command_versionを変更します。
- **/
 GRN_API grn_rc grn_ctx_set_command_version(grn_ctx *ctx, grn_command_version version);
-
-/**
- * grn_ctx_get_match_escalation_threshold:
- *
- * 検索の挙動をエスカレーションする閾値を返します。エスカレー
- * ションの詳細は検索の仕様に関するドキュメントを参照してく
- * ださい。
- **/
 GRN_API long long int grn_ctx_get_match_escalation_threshold(grn_ctx *ctx);
-
-/**
- * grn_ctx_set_match_escalation_threshold:
- * @threshold: 変更後の検索の挙動をエスカレーションする閾値を指定します。
- *
- * 検索の挙動をエスカレーションする閾値を変更します。エスカレー
- * ションの詳細は検索の仕様に関するドキュメントを参照してくだ
- * さい。
- **/
 GRN_API grn_rc grn_ctx_set_match_escalation_threshold(grn_ctx *ctx, long long int threshold);
 
 /**
-------------- next part --------------
HTML����������������������������...
ダウンロード 



More information about the Groonga-commit mailing list
アーカイブの一覧に戻る