[Groonga-commit] groonga/groonga at 2eed618 [master] doc: move grn_match_escalation documents from groonga.h to Sphinx text

Zurück zum Archiv-Index

whombx null+****@clear*****
Sat Aug 10 07:53:04 JST 2013


whombx	2013-08-10 07:53:04 +0900 (Sat, 10 Aug 2013)

  New Revision: 2eed6184ff2008e22b03a9f00f2820aa82251440
  https://github.com/groonga/groonga/commit/2eed6184ff2008e22b03a9f00f2820aa82251440

  Merged cb88575: Merge pull request #97 from whombx/grn-match-escalation

  Message:
    doc: move grn_match_escalation documents from groonga.h to Sphinx text

  Added files:
    doc/source/reference/api/grn_match_escalation.txt
  Modified files:
    doc/files.am
    doc/source/reference/api/grn_ctx.txt
    include/groonga.h

  Modified: doc/files.am (+4 -0)
===================================================================
--- doc/files.am    2013-08-09 23:39:17 +0900 (b1a688b)
+++ doc/files.am    2013-08-10 07:53:04 +0900 (5fa8623)
@@ -354,6 +354,7 @@ absolute_source_files = \
 	$(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_match_escalation.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 \
@@ -825,6 +826,7 @@ source_files_relative_from_doc_dir = \
 	source/reference/api/grn_expr.txt \
 	source/reference/api/grn_index_cursor.txt \
 	source/reference/api/grn_info.txt \
+	source/reference/api/grn_match_escalation.txt \
 	source/reference/api/grn_obj.txt \
 	source/reference/api/grn_table.txt \
 	source/reference/api/grn_table_cursor.txt \
@@ -1063,6 +1065,7 @@ html_files_relative_from_locale_dir = \
 	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_match_escalation.txt \
 	html/_sources/reference/api/grn_obj.txt \
 	html/_sources/reference/api/grn_proc.txt \
 	html/_sources/reference/api/grn_table.txt \
@@ -1234,6 +1237,7 @@ html_files_relative_from_locale_dir = \
 	html/reference/api/grn_expr.html \
 	html/reference/api/grn_index_cursor.html \
 	html/reference/api/grn_info.html \
+	html/reference/api/grn_match_escalation.html \
 	html/reference/api/grn_obj.html \
 	html/reference/api/grn_proc.html \
 	html/reference/api/grn_table.html \

  Modified: doc/source/reference/api/grn_ctx.txt (+0 -14)
===================================================================
--- doc/source/reference/api/grn_ctx.txt    2013-08-09 23:39:17 +0900 (b5cc520)
+++ doc/source/reference/api/grn_ctx.txt    2013-08-10 07:53:04 +0900 (892962d)
@@ -93,20 +93,6 @@ Reference
 
    :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: 変更後の検索の挙動をエスカレーションする閾値を指定します。
-
 .. c:function:: grn_rc grn_ctx_use(grn_ctx *ctx, grn_obj *db)
 
    ctxが操作対象とするdbを指定します。NULLを指定した場合は、dbを操作しない状態(init直後の状態)になります。

  Added: doc/source/reference/api/grn_match_escalation.txt (+39 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/reference/api/grn_match_escalation.txt    2013-08-10 07:53:04 +0900 (09db0f9)
@@ -0,0 +1,39 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_match_escalation``
+========================
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+
+.. 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: 変更後の検索の挙動をエスカレーションする閾値を指定します。
+
+.. c:function:: long long int grn_get_default_match_escalation_threshold(void)
+
+   デフォルトの検索の挙動をエスカレーションする閾値を返します。エスカレーションの詳細は検索の仕様に関するドキュメントを参照してください。
+
+.. c:function:: grn_rc grn_set_default_match_escalation_threshold(long long int threshold)
+
+   デフォルトの検索の挙動をエスカレーションする閾値を変更します。エスカレーションの詳細は詳細は検索の仕様に関するドキュメントを参照してください。
+
+   :param threshold: 変更後のデフォルトの検索の挙動をエスカレーションする閾値を指定します。

  Modified: include/groonga.h (+0 -17)
===================================================================
--- include/groonga.h    2013-08-09 23:39:17 +0900 (d99e79d)
+++ include/groonga.h    2013-08-10 07:53:04 +0900 (9bf7ce1)
@@ -254,24 +254,7 @@ GRN_API grn_command_version grn_ctx_get_command_version(grn_ctx *ctx);
 GRN_API grn_rc grn_ctx_set_command_version(grn_ctx *ctx, grn_command_version version);
 GRN_API long long int grn_ctx_get_match_escalation_threshold(grn_ctx *ctx);
 GRN_API grn_rc grn_ctx_set_match_escalation_threshold(grn_ctx *ctx, long long int threshold);
-
-/**
- * grn_get_default_match_escalation_threshold:
- *
- * デフォルトの検索の挙動をエスカレーションする閾値を返します。
- * エスカレーションの詳細は検索の仕様に関するドキュメントを参
- * 照してください。
- **/
 GRN_API long long int grn_get_default_match_escalation_threshold(void);
-
-/**
- * grn_set_default_match_escalation_threshold:
- * @threshold: 変更後のデフォルトの検索の挙動をエスカレーションする閾値を指定します。
- *
- * デフォルトの検索の挙動をエスカレーションする閾値を変更しま
- * す。エスカレーションの詳細は詳細は検索の仕様に関するドキュ
- * メントを参照してください。
- **/
 GRN_API grn_rc grn_set_default_match_escalation_threshold(long long int threshold);
 
 /* grn_encoding */
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Zurück zum Archiv-Index