[Groonga-commit] groonga/groonga at 99acff7 [master] doc: move grn_search documents from groonga.h to Sphinx text

Back to archive index

whombx null+****@clear*****
Sat Aug 10 02:53:01 JST 2013


whombx	2013-08-10 02:53:01 +0900 (Sat, 10 Aug 2013)

  New Revision: 99acff7e8db0e30ff40d692b4806e8ccd2ef9434
  https://github.com/groonga/groonga/commit/99acff7e8db0e30ff40d692b4806e8ccd2ef9434

  Merged 357d814: Merge branch 'grn-search' of https://github.com/whombx/groonga into whombx-grn-search

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

  Added files:
    doc/source/reference/api/grn_search.txt
  Modified files:
    doc/files.am
    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 02:53:01 +0900 (e462d48)
@@ -356,6 +356,7 @@ absolute_source_files = \
 	$(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_search.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 \
@@ -826,6 +827,7 @@ source_files_relative_from_doc_dir = \
 	source/reference/api/grn_index_cursor.txt \
 	source/reference/api/grn_info.txt \
 	source/reference/api/grn_obj.txt \
+	source/reference/api/grn_search.txt \
 	source/reference/api/grn_table.txt \
 	source/reference/api/grn_table_cursor.txt \
 	source/reference/api/grn_proc.txt \
@@ -1065,6 +1067,7 @@ html_files_relative_from_locale_dir = \
 	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_search.txt \
 	html/_sources/reference/api/grn_table.txt \
 	html/_sources/reference/api/grn_table_cursor.txt \
 	html/_sources/reference/cast.txt \
@@ -1236,6 +1239,7 @@ html_files_relative_from_locale_dir = \
 	html/reference/api/grn_info.html \
 	html/reference/api/grn_obj.html \
 	html/reference/api/grn_proc.html \
+	html/reference/api/grn_search.html \
 	html/reference/api/grn_table.html \
 	html/reference/api/grn_table_cursor.html \
 	html/reference/cast.html \

  Added: doc/source/reference/api/grn_search.txt (+31 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/reference/api/grn_search.txt    2013-08-10 02:53:01 +0900 (0ec44d7)
@@ -0,0 +1,31 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+``grn_search``
+==============
+
+Summary
+-------
+
+TODO...
+
+Example
+-------
+
+TODO...
+
+Reference
+---------
+ 
+.. c:type:: grn_search_optarg
+
+.. c:function:: grn_rc grn_obj_search(grn_ctx *ctx, grn_obj *obj, grn_obj *query, grn_obj *res, grn_operator op, grn_search_optarg *optarg)
+
+   objを対象としてqueryにマッチするレコードを検索し、opの指定に従ってresにレコードを追加あるいは削除します。
+
+   :param obj: 検索対象のobjectを指定します。
+   :param query: 検索クエリを指定します。
+   :param res: 検索結果を格納するテーブルを指定します。
+   :param op: ``GRN_OP_OR``, ``GRN_OP_AND``, ``GRN_OP_AND_NOT``, ``GRN_OP_ADJUST`` のいずれかを指定します。
+   :param optarg: 詳細検索条件を指定します。

  Modified: include/groonga.h (+0 -13)
===================================================================
--- include/groonga.h    2013-08-09 23:39:17 +0900 (d99e79d)
+++ include/groonga.h    2013-08-10 02:53:01 +0900 (af2ee1f)
@@ -1022,19 +1022,6 @@ GRN_API grn_obj *grn_obj_db(grn_ctx *ctx, grn_obj *obj);
  **/
 GRN_API grn_id grn_obj_id(grn_ctx *ctx, grn_obj *obj);
 
-
-/**
- * grn_obj_search:
- * @obj: 検索対象のobject
- * @query: 検索クエリ
- * @res: 検索結果を格納するテーブル
- * @op: GRN_OP_OR, GRN_OP_AND, GRN_OP_AND_NOT, GRN_OP_ADJUSTのいずれかを指定する
- * @optarg: 詳細検索条件
- *
- * objを対象としてqueryにマッチするレコードを検索し、
- * opの指定に従ってresにレコードを追加あるいは削除する。
- **/
-
 typedef struct _grn_search_optarg grn_search_optarg;
 
 struct _grn_search_optarg {
-------------- next part --------------
HTML����������������������������...
下载 



More information about the Groonga-commit mailing list
Back to archive index